documentation-engineer
/documentation-engineer
Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code.
- Author
- tmcfarlane ↗
- Repository
- team-avatar ↗
- Licence
- MIT
- Last repository change
- 25.10.2026
Assessment and security
- Files in this package
- 4
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 25.10.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
What it does and when to use it
Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code.
Original author description
Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code.
How it works
- When This Skill Activates
- Documentation Types
- Documentation Principles
- Writing Guidelines
- Documentation Checklist
- Scripts
- References
SKILL.md preview
---
name: documentation-engineer
description: Technical documentation expert for creating clear, comprehensive documentation. Use when user asks to write docs, create README, or document code.
allowed-tools: Read, Write, Edit, Grep, Glob, WebFetch, WebSearch
metadata:
hooks:
after_complete:
- trigger: session-logger
mode: auto
reason: "Log documentation activity"
---
# Documentation Engineer
Expert in creating clear, comprehensive, and maintainable technical documentation.
## When This Skill Activates
Activates when you:
- Ask to write documentation
- Request README creation
- Mention "docs" or "document this"
- Need API documentation
## Documentation Types
### 1. README
Every project should have a README with:
```markdown
# Project Name
Brief description (what it does, why it exists)
## Quick Start
Installation and usage in 3 steps or less.
## Installation
Detailed installation instructions.
## Usage
Examples of common usage patterns.
## Configuration
Environment variables and configuration options.
## Development
How to run tests, build, and develop locally.
## Contributing
Guidelines for contributors.
## License
License information.
```
### 2. API Documentation
For each endpoint/function:
- **Description**: What it does
- **Parameters**: Name, type, required/optional, description
- **Return value**: Type and structure
- **Errors**: Possible errors and conditions
- **Examples**: Usage examples
### 3. Code Comments
Comment **why**, not **what**:
```typescript
// Bad: Sets the count to zero
count = 0;
// Good: Reset count for new measurement cycle
count = 0;
// Bad: Check if user is admin
if (user.role === 'admin') {
// Good: Only admins can bypass approval workflow
if (user.role === 'admin') {
```
### 4. Architecture Documentation
- System overview
- Component relationships
- Data flow
- Design decisions
- Trade-offs considered
## Documentation Principles
1. **Be Clear**: Use simple, direct language
2. **Be Concise**: Respect the reader's time
3. **Be Accurate**: Keep docs in sync with code
4. **Be Complete**: Cover all public interfaces
5. **Be Current**: Update docs when code changes
## Writing Guidelines
### Headings
- Use sentence case for headings
- Start with a verb or noun
- Be descriptive
### Code Examples
- Show before/after when appropriate
- Include import statements
- Show expected output
- Handle edge cases
### Links
- Use relative links for internal docs
- Include anchors for sections
- Test that links work
### Diagrams
- Use Mermaid for flowcharts and sequences
- Keep diagrams simple
- Add a title and legend
## Documentation Checklist
### README
- [ ] Project description
- [ ] Quick start guide
- [ ] Installation instructions
- [ ] Usage examples
- [ ] Configuration guide
- [ ] Contributing guidelines
### Code Docs
- [ ] All public functions documented
- [ ] Parameters and returns documented
- [ ] Examples provided for complex functions
- [ ] Edge cases documented
### API Docs
- [ ] All endpoints documented
- [ ] Request/response schemas
- [ ] Authentication requirements
- [ ] Error responses documented
- [ ] Rate limits documented
## Scripts
Generate documentation structure:
```bash
python scripts/generate_docs.py
```
Validate documentation:
```bash
python scripts/validate_docs.py
```
## References
- `references/readme-template.md` - README template
- `references/api-template.md` - API documentation template
- `references/style-guide.md` - Documentation style guide
Files in this package (4)
- SKILL.md 3 KB
- references/api-template.md 1 KB
- references/readme-template.md 1 KB
- references/style-guide.md 1 KB
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · tmcfarlane/team-avatar | 100 | MIT |
| agentic-swe/agentic-swe | 100 | MIT |
| arijeetganguli/ai-kaarkhana | 100 | MIT |
| arijeetganguli/ai-kaarkhana | 100 | MIT |
| zhaono1/agent-playbook | 100 | MIT |
| charlieviettq/awesome-agent-skill | 100 | MIT |
Database snapshot: 13.11.2026 · package version 0fe219372f29 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100documentation
Creates clear, comprehensive documentation. Use when writing READMEs, API docs, code comments, or user guides. Follows documentation best practices. - 100documentation
Write and maintain technical documentation. Trigger with "write docs for", "document this", "create a README", "write a runbook", "onboarding guide", or when the user needs help with any form of technical writing — API docs, architecture docs, or operational runbooks. - 100document
Technical documentation expert for creating clear, comprehensive documentation including API docs (OpenAPI), ADRs, system architecture docs, developer guides, and runbooks. Use when creating or improving technical documentation. - 95readme
When the user wants to create or update a README.md file for a project. Also use when the user says 'write readme,' 'create readme,' 'document this project,' 'project documentation,' or asks for he... - 100code-documentation
Analyze source code repositories and create, update, and validate accurate technical documentation. Use when developers request README generation, API documentation, architecture documentation, codebase explanation, or documentation maintenance. - 100readme-generator-free
Generate polished README files from project code. Use when the user says "generate readme", "create README", "write project documentation", "make a readme", or asks for README generation, project documentation, installation docs, usage docs, API docs, badges, or repository…