docs-and-voice
Skill1 starsChanged 7 days agoMITView on GitHub
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, no humour in reference or steps. Use when writing a README, docs page, release note, issue reply or pull request description.
In this repository40 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- add-a-use-caseSkill
- api-conventionsSkill
- branches-and-pull-requestsSkill
- cancellationSkill
- ci-for-your-solutionSkill
- ci-pipelineSkill
- clean-architecture-layersSkill
- configuration-and-environmentsSkill
- coverageSkill
- csharp-house-styleSkill
- data-access-ef-coreSkill
- database-migrationsSkill
- docker-and-composeSkill
- errors-and-exceptionsSkill
- expose-a-use-caseSkill
- family-syncSkill
- health-checksSkill
- integration-testsSkill
- json-serializationSkill
- mapping-with-mapperlySkill
- mcp-inspectorSkill
- mediatorSkill
- optional-token-authSkill
- packages-and-dependenciesSkill
- pagingSkill
- presentation-integration-testsSkill
- releasesSkill
- sample-dataSkill
- security-findingsSkill
- serilogSkill
- telemetrySkill
- template-authoringSkill
- test-designSkill
- time-providerSkill
- unit-testsSkill
- validationSkill
- writing-a-skillSkill
- xml-docs-and-openapiSkill
The file
We split this skill into the rules it gives an agent
4 rules. About 0 are common, 4 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈4
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 39
Use marketing words ("blazing fast", "revolutionary", "seamless").
- Distinctive: line 40
Put jokes in steps, tables or error messages.
- Distinctive: line 42
Write in the first person singular.
- Distinctive: line 46
Read it out loud. If a sentence needs a second breath, split it.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
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 |
| Reference tables, steps, commands, 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, tables or error messages.
- 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.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.