section-writer
Skill2 starsChanged 4 months agoApache-2.0View on GitHub
Writes publishable Markdown documentation sections using the planned architecture, glossary, examples, assumptions, and technical depth rules.
In this repository11 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- audience-alignmentSkill
- document-architectureSkill
- examples-and-edge-casesSkill
- glossary-builderSkill
- knowledge-mappingSkill
- output-formatsSkill
- product-discoverySkill
- publishingSkill
- technical-documentation-frameworkSkill
- technical-reviewSkill
The file
We split this skill into the rules it gives an agent
5 rules. About 0 are common, 5 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈5
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 10
Write the documentation sections in publishable Markdown.
- Distinctive: line 24
No marketing exaggeration or filler intensifiers
- Distinctive: line 48
Use these unless the product type suggests a better structure:
- Distinctive: line 75
Use the glossary's preferred term consistently.
- Distinctive: line 79
Use examples that match the user's product domain.
≈ “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
Section Writer Skill
Purpose
Write the documentation sections in publishable Markdown.
Required style
Apply rules/writing-style-rules.md and rules/natural-writing-rules.md while drafting — not as a cleanup step afterwards.
- Clear headings
- Short paragraphs, with sentence length varied inside them
- Concrete explanations; every section opens with a fact, never with "This section describes..."
- Consistent terminology; new terms explained on first use
- Practical examples
- Explicit assumptions
- Tables where helpful
- No unsupported claims
- No marketing exaggeration or filler intensifiers
Generic section template
## Section Title
This section explains ...
### What it is
### Why it matters
### How it works
### Example
### Important details
### Common mistakesRequired sections for broad product documentation
Use these unless the product type suggests a better structure:
- Overview
- Problem Statement
- Target Audience
- What This Product Is
- What This Product Is Not
- Core Concepts
- Architecture or Operating Model
- Core Components
- Runtime Flow
- Getting Started
- Configuration
- Usage Scenarios
- API, SDK, or Integration Reference
- Examples
- Edge Cases
- Security and Authorization
- Observability
- Troubleshooting
- Product Boundaries
- FAQ
- Glossary
Writing rules
- Define important terms before using them heavily.
- Use the glossary's preferred term consistently.
- Mention assumptions where information is missing.
- Make boundaries explicit.
- Separate conceptual explanation from operational steps.
- Use examples that match the user's product domain.
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.

