Initial commit
This commit is contained in:
@@ -0,0 +1,152 @@
|
||||
{
|
||||
"standards": [
|
||||
{
|
||||
"id": "std-101",
|
||||
"name": "Industrial Equipment Safety Standards",
|
||||
"description": "Core safety requirements for industrial equipment and machinery",
|
||||
"requirements": [
|
||||
{
|
||||
"id": "req-101-01",
|
||||
"description": "All equipment must have emergency stop mechanisms within operator reach",
|
||||
"severity": "critical",
|
||||
"details": "Emergency stops must be red in color, clearly marked, and accessible from all operating positions"
|
||||
},
|
||||
{
|
||||
"id": "req-101-02",
|
||||
"description": "Moving parts must be guarded with appropriate safety barriers",
|
||||
"severity": "critical",
|
||||
"details": "Guards must be secured with tamper-resistant fasteners and interlocked where applicable"
|
||||
},
|
||||
{
|
||||
"id": "req-101-03",
|
||||
"description": "Equipment must display appropriate warning labels and safety instructions",
|
||||
"severity": "major",
|
||||
"details": "Labels must be in local language and use standardized safety symbols"
|
||||
},
|
||||
{
|
||||
"id": "req-101-04",
|
||||
"description": "Operating manual must include maintenance schedules and procedures",
|
||||
"severity": "major",
|
||||
"details": "Include daily, weekly, monthly, and annual maintenance requirements"
|
||||
},
|
||||
{
|
||||
"id": "req-101-05",
|
||||
"description": "Equipment noise levels must not exceed 85dB during normal operation",
|
||||
"severity": "major",
|
||||
"details": "Measured at operator position under full load conditions"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "std-102",
|
||||
"name": "Quality Control Documentation",
|
||||
"description": "Documentation requirements for quality control processes",
|
||||
"requirements": [
|
||||
{
|
||||
"id": "req-102-01",
|
||||
"description": "Each equipment must have a unique serial number and QC tracking code",
|
||||
"severity": "critical",
|
||||
"details": "Serial numbers must be permanently marked and recorded in production database"
|
||||
},
|
||||
{
|
||||
"id": "req-102-02",
|
||||
"description": "Test results must be documented for each critical component",
|
||||
"severity": "major",
|
||||
"details": "Include test parameters, results, and operator identification"
|
||||
},
|
||||
{
|
||||
"id": "req-102-03",
|
||||
"description": "Calibration records must be maintained for all measuring equipment",
|
||||
"severity": "major",
|
||||
"details": "Include calibration date, due date, and calibration certificate reference"
|
||||
},
|
||||
{
|
||||
"id": "req-102-04",
|
||||
"description": "Non-conformance reports must be filed for any quality deviations",
|
||||
"severity": "major",
|
||||
"details": "Document root cause analysis and corrective actions taken"
|
||||
},
|
||||
{
|
||||
"id": "req-102-05",
|
||||
"description": "Quality control procedures must be reviewed annually",
|
||||
"severity": "minor",
|
||||
"details": "Update procedures based on audit findings and process improvements"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "std-103",
|
||||
"name": "Environmental Compliance",
|
||||
"description": "Environmental protection and sustainability requirements",
|
||||
"requirements": [
|
||||
{
|
||||
"id": "req-103-01",
|
||||
"description": "Equipment must meet current energy efficiency standards",
|
||||
"severity": "major",
|
||||
"details": "Comply with ISO 50001 energy management standards"
|
||||
},
|
||||
{
|
||||
"id": "req-103-02",
|
||||
"description": "Hazardous materials must be properly labeled and documented",
|
||||
"severity": "critical",
|
||||
"details": "Include MSDS and handling procedures for all hazardous materials"
|
||||
},
|
||||
{
|
||||
"id": "req-103-03",
|
||||
"description": "Waste disposal procedures must be documented and followed",
|
||||
"severity": "major",
|
||||
"details": "Specify appropriate disposal methods for different waste categories"
|
||||
},
|
||||
{
|
||||
"id": "req-103-04",
|
||||
"description": "Equipment must not contain prohibited substances",
|
||||
"severity": "critical",
|
||||
"details": "Comply with RoHS and REACH regulations"
|
||||
},
|
||||
{
|
||||
"id": "req-103-05",
|
||||
"description": "Environmental impact assessment must be conducted",
|
||||
"severity": "major",
|
||||
"details": "Include carbon footprint and resource consumption analysis"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "std-104",
|
||||
"name": "Technical Documentation Requirements",
|
||||
"description": "Standards for technical documentation and manuals",
|
||||
"requirements": [
|
||||
{
|
||||
"id": "req-104-01",
|
||||
"description": "All technical documents must be version controlled",
|
||||
"severity": "major",
|
||||
"details": "Include revision history and change log"
|
||||
},
|
||||
{
|
||||
"id": "req-104-02",
|
||||
"description": "Documentation must be available in specified languages",
|
||||
"severity": "major",
|
||||
"details": "Minimum requirement: English, Spanish, and Mandarin"
|
||||
},
|
||||
{
|
||||
"id": "req-104-03",
|
||||
"description": "Technical specifications must include dimensional drawings",
|
||||
"severity": "major",
|
||||
"details": "Provide both metric and imperial measurements"
|
||||
},
|
||||
{
|
||||
"id": "req-104-04",
|
||||
"description": "Troubleshooting guides must include decision trees",
|
||||
"severity": "minor",
|
||||
"details": "Cover common issues and resolution steps"
|
||||
},
|
||||
{
|
||||
"id": "req-104-05",
|
||||
"description": "Electronic documentation must be searchable",
|
||||
"severity": "minor",
|
||||
"details": "Provide PDF with OCR and proper bookmarking"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,132 @@
|
||||
{
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
Reference in New Issue
Block a user