Documentation Authoring Process

OpenStair documentation should be created as canonical knowledge, not as disposable notes.

Before writing a new document, identify whether the topic already has a source of truth. If it does, update the existing document instead of creating a duplicate.

Authoring Steps

• Identify the topic and collection.
• Confirm the document does not duplicate an existing canonical source.
• Write the document using Markdown V1 capabilities.
• Add required metadata.
• Keep the document focused on one topic.
• Review naming, tone, and duplicated content.
• Run validation through the project build before publishing.

Review Expectations

Documentation should be reviewed for correctness, clarity, ownership, and long-term usefulness.

Technical documents should be reviewed by engineering. Business documents should be reviewed by business or management. Legal documents should be reviewed by the appropriate responsible owner.

Publishing Boundary

Current OKP documents are public when visibility is set to public. Sensitive internal content should not be added until private visibility is fully enforced.