MIL-STD-498 Documentation Repository

This repository contains a complete collection of MIL-STD-498 (Military Standard 498) document templates in multiple formats. MIL-STD-498 is a United States military standard that defines the software development and documentation process for software systems.

🌐 Live Documentation Site

📖 View the complete documentation online

The documentation is automatically generated and published to GitHub Pages with both original HTML and StrictDoc-generated versions of all MIL-STD-498 documents.

📁 Repository Structure

Original Source Documents (from kkovacs.eu)

• original/original_MIL-STD-498_html/ - Original MIL-STD-498 HTML templates (22 files)

  • Source: kkovacs.eu
  • Well-structured XHTML 1.0 Transitional format
  • Consistent document structure across all templates
  • Direct attribution: These files are sourced directly from kkovacs.eu

• original/original_MIL-STD-498_md/ - Markdown versions of HTML templates (22 files)

  • Converted from HTML using Pandoc
  • Maintains document structure and hierarchy
  • Some formatting artifacts from HTML conversion
  • Source: Derived from kkovacs.eu HTML templates

StrictDoc Generated Files

• strictdoc_md/ - StrictDoc (.sdoc) files generated from Markdown sources (22 files)

  • Each Markdown heading becomes a separate [REQUIREMENT] block
  • Proper grammar compliance with StrictDoc specification
  • Generated HTML: https://automotivedevops.github.io/MIL-STD-498/strictdoc_md/html/strictdoc_md/

• strictdoc_html/ - StrictDoc (.sdoc) files generated from HTML sources (22 files)

  • Each HTML heading becomes a separate [REQUIREMENT] block
  • Proper grammar compliance with StrictDoc specification
  • Generated HTML: https://automotivedevops.github.io/MIL-STD-498/strictdoc_html/html/strictdoc_html/

Output Directories

• final_output/ - HTML output from Markdown-based StrictDoc files
• final_output_html/ - HTML output from HTML-based StrictDoc files
• test_output/ - Test HTML output for validation
• output/ - Legacy output directory

📋 Document Types

Requirements Documents

• SRS - Software Requirements Specification

  • Defines software requirements and acceptance criteria
  • Original: HTML

• SSS - System/Subsystem Specification

  • System-level requirements and specifications
  • Original: HTML

• IRS - Interface Requirements Specification

  • Interface requirements between system components
  • Original: HTML

Design Documents

• SDD - Software Design Description

  • Software architectural and detailed design
  • Original: HTML

• SSDD - System/Subsystem Design Description

  • System-level design descriptions
  • Original: HTML

• IDD - Interface Design Description

  • Interface design specifications
  • Original: HTML

• DBDD - Database Design Description

  • Database design and structure
  • Original: HTML

Planning Documents

• SDP - Software Development Plan

  • Comprehensive software development planning
  • Original: HTML

• STP - Software Test Plan

  • Software testing strategy and procedures
  • Original: HTML

• SIP - Software Installation Plan

  • Software installation procedures
  • Original: HTML

• SCOM - Software Configuration Management Plan

  • Configuration management planning
  • Original: HTML

Testing Documents

• STR - Software Test Report
  • Test execution results and reports
  • Original: HTML

User Documentation

• COM - Computer Operator Manual

  • Computer system operation manual
  • Original: HTML

• CPM - Computer Program Manual

  • Computer program usage manual
  • Original: HTML

• SUM - Software User Manual

  • Software user manual
  • Original: HTML

• SIOM - Software Input/Output Manual

  • Input/output procedures manual
  • Original: HTML

Transition & Installation

• STRP - Software Transition Plan

  • Software transition planning
  • Original: HTML

• SVD - Software Version Description

  • Version description and release notes
  • Original: HTML

Support Documentation

• FSM - Firmware Support Manual

  • Firmware support procedures
  • Original: HTML

• OCD - Operational Concept Description

  • Operational concept descriptions
  • Original: HTML

Additional Documents

• SPS - Software Product Specification

  • Software product specifications
  • Original: HTML

• STD - Software Transition Document

  • Software transition documentation
  • Original: HTML

🚀 GitHub Pages Deployment

This repository uses GitHub Actions to automatically:

1. Generate HTML documentation from StrictDoc files
2. Copy original MIL-STD-498 HTML files
3. Create a comprehensive index page with navigation
4. Deploy everything to GitHub Pages

Workflow Details

• Trigger: Push to master branch or manual dispatch
• Build: Uses Python 3.12 with StrictDoc
• Dependencies: StrictDoc, BeautifulSoup4, html2text
• Output: Complete documentation site with navigation

🛠️ Local Development

Prerequisites

• Python 3.12+
• Virtual environment (recommended)

Setup

# Clone the repository
git clone https://github.com/AutomotiveDevOps/MIL-STD-498.git
cd MIL-STD-498

# Create virtual environment and install dependencies
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install strictdoc beautifulsoup4 html2text

# Generate HTML documentation locally
python3 convert_to_strictdoc_final.py
venv/bin/strictdoc export --formats=html --output-dir=docs/ strictdoc_md/

📖 Usage

Viewing Documentation

• 🌐 Online: Visit https://automotivedevops.github.io/MIL-STD-498/
• 💻 Local: Open docs/index.html in your browser after generation

Using StrictDoc Files

The StrictDoc (.sdoc) files can be used with StrictDoc to generate various output formats:

# Generate HTML
venv/bin/strictdoc export --formats=html --output-dir=output/ strictdoc_md/

# Generate PDF
venv/bin/strictdoc export --formats=pdf --output-dir=output/ strictdoc_md/

# Generate ReqIF
venv/bin/strictdoc export --formats=reqifspec --output-dir=output/ strictdoc_md/

🔄 Automation

The repository includes automated workflows for:

• Documentation Generation: Converts StrictDoc files to HTML
• GitHub Pages Deployment: Publishes documentation automatically
• Index Generation: Creates comprehensive navigation

📄 License

This project contains MIL-STD-498 templates. Please refer to the original MIL-STD-498 standard for licensing information.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

📞 Support

For questions or issues, please open an issue on GitHub.

📚 Source Attribution

• Original HTML Templates: Directly sourced from kkovacs.eu
  • These are the authoritative MIL-STD-498 document templates
  • All HTML files in original/original_MIL-STD-498_html/ come directly from kkovacs.eu
• Markdown conversion: Performed using Pandoc on kkovacs.eu HTML templates
• Standard reference: MIL-STD-498 on Wikipedia
• StrictDoc: StrictDoc Documentation

📊 Repository Status

• Current state: Clean working tree, all changes committed
• Documentation: Complete set of MIL-STD-498 templates
• Formats: HTML, Markdown, and StrictDoc versions available
• Maintenance: Repository is stable and well-maintained
• Automation: Fully automated documentation generation and deployment