其他技能
docs-and-voice
Where documentation lives (README, docs/RUN.md, the Lean Mean Clean Apps docs site) and the house voice - professional with a dry sense of humour, Australian spelling, humour in prose but never in steps, commands or tables. Use when writing a README, docs page, release note, issue reply or pull request description.
LeanMeanCleanApps · 已有静态检查记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add LeanMeanCleanApps/CleanMinimalApi --skill docs-and-voice技能说明
name: docs-and-voice description: Where documentation lives (README, docs/RUN.md, the Lean Mean Clean Apps docs site) and the house voice - professional with a dry sense of humour, Australian spelling, humour in prose but never in steps, commands or tables. Use when writing a README, docs page, release note, issue reply or pull request description. metadata: scope: repository
Docs and voice
The rule
| What | Where |
|---|---|
| A short introduction, install, the options table and links | README.md and NUGET.md (the package page) |
| Running the app, environments, database and tests | docs/RUN.md, which also ships in every generated solution |
| Full guides | The docs site, https://leanmeancleanapps.github.io, in the leanmeancleanapps.github.io repository, with a home page per template |
| How to contribute | CONTRIBUTING.md |
| How agents work here | AGENTS.md and .agents/ |
The voice is a small team that knows its stuff and doesn't take itself too seriously: the Lean Mean Clean Apps team, which is Stephen Walsh for now and open to more. Professional first, with the odd dry line.
| Kind of writing | Humour |
|---|---|
| Home pages, introductions, explanations, contributing guides | Yes, lightly, one line at a time |
| Guides and reference pages, troubleshooting included | Yes, one dry line in an introduction or a section's prose |
| Steps, commands, tables, error messages, skills | None |
The templates are always listed in the same order: Minimal API, MCP, GraphQL, Web API, Lambda Function.
Steps
- Lead with the point. Short sentences, plain words, Australian spelling (behaviour, colour, initialise).
- Show the command or the code instead of describing it.
- Change the docs in the same pull request as the behaviour they describe.
- Guides go to the docs site repository, not into this repository.
- Release notes come from pull request titles, so write titles as plain sentences about the change.
Don't
- Use marketing words ("blazing fast", "revolutionary", "seamless").
- Put jokes in steps, commands, tables or error messages, or let one bend a fact.
- Duplicate a guide from the docs site in the README.
- Write in the first person singular; it's "we" and "the team".
Check
Read it out loud. If a sentence needs a second breath, split it.