documentation
Owns how any document is written, with its sentences, terms, paragraphs and lists, and what a README holds. Use before writing or changing a technical document, README or doc comment; instructions for an agent add the prompting skill's rules.
- License 许可
- MIT
- 最近更新
- 2026-11-15
- Stars
- ★ 15
- Forks
- 3
01 前言 Front Matter
- name
- documentation
- description
- Owns how any document is written, with its sentences, terms, paragraphs and lists, and what a README holds. Use before writing or changing a technical document, README or doc comment; instructions for an agent add the prompting skill's rules.
02 资源文件 1
- 参考文档writing.md2.9 KB
03 SKILL.md 正文
Documentation
Good writing is the same for every reader: deliver the core point concisely and clearly. Only the reader, and so what the reader needs, differs by document.
Every document follows Writing. A README adds the rules below.
READMEs
Write a README from the view of the person who uses its project or package, and keep it to the essentials:
- what it is and when to use it;
- how to install and start it;
- the few entry points;
- where the detail lives.
A README lists no API that the source and its types already own, because that list goes stale at the next change, and it carries nothing only a maintainer needs. Every name, command and sample in it exists in the code, and every sample runs.
Doc comments
The project's development skill names what a public declaration's comment must say.
04 同仓库更多 Skills
story-workflow
Chooses the story route and who writes the screenplay, and routes to each route's steps and to completion. Use when starting, resuming or completing narrative work.
story-correction
Inspects a narrative body and repairs it by cause, at its earliest owner and within closed boundaries. Use before evidence, after review findings, or when requirements or scope change.
development
Implements and tests production source, integrations, dependencies and commands, reusing installed packages before writing a capability. Use for code or host changes and behavioral tests; documentation owns technical writing and story owns creative bodies.
pull-request
Branches, commits, pushes, opens, updates, and merges automovie pull requests. Use only when the user asks for one of those actions or a mandate names delivery.
issue-campaign
Runs automovie's issue campaign, repeating full discovery rounds until one finds nothing new, publishing the issues, and landing them in one pull request per cycle. Use for a broad audit or repeated issue-to-pull-request work, not for one defined issue.
contracts
Defines the @evidence checklists every maintained automovie declaration and test answers, and their evidence.config.ts wiring. Use when writing or reviewing maintained source or tests, or changing Evidence selection.