Carlos Florêncio
29 lines
1.4 KiB
Markdown
29 lines
1.4 KiB
Markdown
# Specification Guide
|
|
|
|
This guide defines the Kandev specification system. The guide is the canonical
|
|
source for specification rules. Skills and templates reference these rules.
|
|
|
|
Read only the files that apply to the current task:
|
|
|
|
- [Structure and ownership](structure-and-ownership.md) defines systems,
|
|
directories, ownership, and document-size limits.
|
|
- [Requirements](requirements.md) defines requirements and acceptance criteria.
|
|
- [System design](system-design.md) defines technical design documents.
|
|
- [Traceability and lifecycle](traceability-and-lifecycle.md) defines IDs,
|
|
references, statuses, and migration rules.
|
|
- [Plans and work orders](plans-and-work-orders.md) defines delivery records.
|
|
|
|
The [system README](../templates/system-readme.md),
|
|
[requirement](../templates/requirement.md), and
|
|
[system-design](../templates/system-design.md) templates provide the required
|
|
document shapes.
|
|
|
|
## Authoring language
|
|
|
|
Write all specification, system-design, plan, and work-order files in English.
|
|
Use English for filenames, frontmatter, IDs, titles, headings, prose, examples,
|
|
comments, and results. Translate non-English task input before recording it.
|
|
Do not copy the original wording into an engineering artifact. Keep non-English
|
|
text only for intentional product localization or exact product data required
|
|
by the contract. Keep the surrounding explanation in English.
|