{ "standards": [ { "id": "std-001", "name": "Technical Documentation Structure", "description": "Standard for the structure of technical documentation", "requirements": [ { "id": "req-001-01", "description": "Document must include a title and version number", "severity": "critical" }, { "id": "req-001-02", "description": "Document must include a table of contents for documents longer than 10 pages", "severity": "major" }, { "id": "req-001-03", "description": "Each major section must start on a new page", "severity": "minor" }, { "id": "req-001-04", "description": "Document must include an introduction section", "severity": "major" }, { "id": "req-001-05", "description": "Document must include a conclusion or summary section", "severity": "major" } ] }, { "id": "std-002", "name": "Technical Content Requirements", "description": "Standard for technical content quality and completeness", "requirements": [ { "id": "req-002-01", "description": "All technical terms must be defined either in-text or in a glossary", "severity": "major" }, { "id": "req-002-02", "description": "Code examples must include comments explaining their functionality", "severity": "major" }, { "id": "req-002-03", "description": "Diagrams must include captions and labels", "severity": "major" }, { "id": "req-002-04", "description": "All claims must be supported by evidence or references", "severity": "critical" }, { "id": "req-002-05", "description": "Document must not contain placeholder or lorem ipsum text", "severity": "critical" } ] }, { "id": "std-003", "name": "Writing Style and Formatting", "description": "Standard for consistent writing style and formatting", "requirements": [ { "id": "req-003-01", "description": "Document must use consistent formatting for headings, lists, and code blocks", "severity": "minor" }, { "id": "req-003-02", "description": "Sentences should be concise (preferably under 25 words)", "severity": "minor" }, { "id": "req-003-03", "description": "Active voice should be used where possible", "severity": "minor" }, { "id": "req-003-04", "description": "Spelling and grammar must be correct throughout the document", "severity": "major" }, { "id": "req-003-05", "description": "Acronyms must be defined on first use", "severity": "major" } ] }, { "id": "std-004", "name": "Technical Accuracy", "description": "Standard for ensuring technical accuracy", "requirements": [ { "id": "req-004-01", "description": "All technical specifications must be accurate and up-to-date", "severity": "critical" }, { "id": "req-004-02", "description": "Code examples must be tested and functional", "severity": "critical" }, { "id": "req-004-03", "description": "API endpoints must include all required parameters and response formats", "severity": "critical" }, { "id": "req-004-04", "description": "Error cases and edge conditions must be documented", "severity": "major" }, { "id": "req-004-05", "description": "Version compatibility information must be provided for all dependencies", "severity": "major" } ] } ] }