crebain CLAUDE.md

CREBAIN Claude guide

Follow all repository instructions in AGENTS.md. The instructions in that file are authoritative for commands, code style, architecture, tests, and documentation consistency.

Documentation style

Use the principles of ASD-STE100 Simplified Technical English, Issue 9 for new or changed technical prose. The official ASD-STE100 site identifies Issue 9, dated January 15, 2025, as the current standard. These rules are the CREBAIN house-style adaptation. Do not claim that a document fully conforms to ASD-STE100 unless a qualified review verifies it.

• Use American English and approved project terminology. Use one technical term for one concept.
• Write short, direct sentences. Use no more than 20 words in a procedural sentence and 25 words in a descriptive sentence when practical.
• Give one instruction in each numbered step. Use the imperative form for instructions.
• Put a condition before the action that depends on it.
• Use active voice. Use passive voice only when the actor is unknown or the actor is less important than the action.
• Give one topic in each sentence. Keep related sentences in one paragraph, and use no more than six sentences in a paragraph when practical.
• Use a vertical list for complex information. Do not use semicolons in prose.
• Define each abbreviation at its first use. Do not change exact identifiers, command names, code, protocol terms, quoted text, or required legal text.
• Use requirement words consistently: must states a requirement, must not states a prohibition, may gives permission, and can states capability. Do not replace these words if the replacement changes the contract.
• Use WARNING for a risk of injury or death. Use CAUTION for a risk of damage. Start the safety instruction with a command or condition, then state the possible result.
• Do not use slang, unexplained jargon, Latin abbreviations, or a word-for-word substitution that changes the meaning. Rewrite the sentence when necessary.
• Treat CREBAIN names, source identifiers, API names, and domain-specific vocabulary as technical terms. Keep their spelling consistent.
• Preserve the meaning of historical records, frozen evidence, generated files, vendored documentation, quotations, licenses, and codes of conduct.
• Give each complex SVG diagram concise alt text and an adjacent prose text alternative. Keep each SVG self-contained and accessible.