Documentation Guidelines

OpenStair documentation should be clear, useful, maintainable, and owned.

Every document should explain one topic well. If a document starts covering multiple unrelated topics, split it into separate canonical documents and reference them by subject.

Writing Principles

• Write for the reader who needs to act on the information.
• Keep statements specific and verifiable.
• Avoid filler, vague claims, and repeated company descriptions.
• Use short sections with clear headings.
• Prefer direct language over decorative language.
• Keep canonical facts in one document.

Metadata

Every document must include supported frontmatter:

• title
• description
• collection
• order
• visibility
• updatedAt

Do not invent metadata until the platform supports and validates it.

Canonical Knowledge

If a topic already has a canonical document, do not rewrite the same content elsewhere. Refer to the topic and keep the original document as the source of truth.