Documentation standard and procedure format
The intended reference is ASD-STE100 Simplified Technical English. It was developed for clear technical and maintenance documentation. Official reference: ASD-STE100.
Status of this project
This is a Markdown automation manual with an ASD-STE100-inspired writing approach. It is not a certified aircraft maintenance manual. Formal compliance requires review against the complete current rules, dictionary and permitted technical terms. That full compliance review has not been performed. An age target or short sentence alone does not establish STE compliance.
S1000D is a separate specification for technical publications and reusable data modules. This folder is not an S1000D XML/Common Source Database delivery. Reference: About S1000D.
Procedure pattern
Each numbered step states its purpose, prerequisites, input, procedure, expected output and failure action. Use one action per numbered instruction. Use active verbs and consistent names. Aim for no more than 20 words in each instruction sentence. Explain necessary technical terms in glossary and crypto-layer-2-reference. Keep code, quoted source text and historical evidence clearly separate from procedural prose. Give the operator an observable check and a recovery action.
Review before release
- Follow every procedure from its stated prerequisites.
- Compare each instruction with the implementation.
- Check file paths, source links and date boundaries.
- Confirm that the acceptance check measures the claimed result.
- Mark untested features and unavailable sources.
- Preserve the student's authorship and genuine feedback requirements.