Documentation writing standard
Write M-Press documentation with a controlled, task-focused technical English style.
M-Press documentation uses an ASD-STE100-based house style. This is a project writing standard. It is not a statement of formal ASD-STE100 conformance.
Choose one document type
Each page must meet one primary reader need:
| Type | Reader need | Content |
|---|---|---|
| Tutorial | Learn by doing | One complete and repeatable path |
| How-to guide | Complete a task | Direct steps for a defined result |
| Reference | Find facts while working | Complete and consistent descriptions |
| Explanation | Understand a subject | Reasons, context, and trade-offs |
Do not put long explanations in a procedure. Link to an explanation page.
Use controlled technical English
Apply these rules:
- Use one term for one concept.
- Use a word with one meaning in a sentence.
- Use active voice when the actor is important.
- Use the imperative form for an instruction.
- Put one action in each instruction.
- Put a condition before the action that depends on it.
- Keep sentences short. Split a sentence when it contains two independent facts.
- Do not use vague pronouns such as it or this when the noun is unclear.
- Do not use marketing idioms, jokes, or culture-specific expressions in a procedure.
- Put a warning before the action that can cause harm or data loss.
Product names, command names, configuration keys, and necessary technical terms are approved project vocabulary. Define an unfamiliar term at its first use.
Write procedures that can be tested
State the prerequisite, the action, and the expected result. Use exact commands. Use one supported path in a tutorial. Put alternatives in a how-to guide.
After you write a procedure, run it in a clean fixture. Check every link and code sample. If the result has a user interface, check it at desktop and mobile widths.