Purpose
- •Create one new task document under design/tasks.
Steps
- •Decide file path
- •Standard paths:
- •
design/tasks/YYYY/MM/DD/YYYYMMDDa-short-slug.md(English) - •
design/tasks/YYYY/MM/DD/YYYYMMDDa-short-slug.ja.md(Japanese)
- •
- •Default language is Japanese.
- •Follow the user’s instructions if they specify path, date, language, or slug.
- •Draft the document
- •Use GUIDE.md for English tasks or GUIDE.ja.md for Japanese tasks.
- •Follow the schema and template defined in the applicable guide.
- •Refer to existing task files for style and granularity.
- •Apply front-matter rules
- •Set
idas the task doc-id and keep it unique across the entire repository. - •Keep
idaligned with the filename stem. - •Set
adrsas a string array of related ADR doc-ids (use[]when none yet). - •Keep
plansas a string array of related plan doc-ids when applicable.
- •Apply references rules
- •Keep a markdown reference list at the end of the file.
- •For links to markdown documents that define front-matter
id:, use that doc-id as the reference label (no.md/.ja.mdin labels). - •Use label-style references in the body (for example,
[K4x-ADR-014]).
- •Finalize
- •Run
make gen-indexafter creating the file to refresh task indexes.