Open Knowledge CLI Documentation
Frontmatter10 fields
type
Rule
title
ASD-STE100
description
Write project-authored Wiki text with ASD-STE100 Issue 9.
rule_id
asd-ste100
rule_label
ASD-STE100
rule_summary
Write project-authored Wiki text with ASD-STE100 Issue 9.
rule_review_prompt
Verify changed Wiki text against ASD-STE100 Issue 9 and the approved project terms.
rule_review_evidence
  • Wiki/AGENTS.md
  • Wiki/workflows/feature-docs.md
  • Wiki/
timestamp

ASD-STE100

Instructions

  • Write all project-authored Wiki text with ASD-STE100 Issue 9.
  • Use American English.
  • Use the active voice and simple verb tenses.
  • Use one technical term for one item or action.
  • Keep descriptive sentences to a maximum of 25 words.
  • Keep instructions to a maximum of 20 words.
  • Put only one instruction in each procedural sentence.
  • Start each instruction with an imperative verb.
  • Do not use contractions, phrasal verbs, or semicolons.
  • Keep each paragraph on one topic and to a maximum of six sentences.
  • Treat Open Knowledge product terms and programming terms as approved technical terms.
  • Use okn in user-facing command examples.
  • Preserve the upstream text in SPEC.md. Apply this rule only to its local notice.

Reference

Use the official ASD-STE100 Issue 9 for the complete rules and dictionary.

Powered by OpenKnowledge.sh