# docgarden
A Claude Code skill that writes your engineering docs and keeps them true. It picks the right doc type, checks every fact in your code, and updates the README when something changes.
**Status:** v0.1.0, as of 2026-10-08. First used on a real cloud migration and a team skills repo.
## Why
Docs rot because nobody tends them. A runbook says one command, the code runs another, and the README still lists a folder that moved months ago. docgarden treats docs like a garden: plant the right doc in the right place, then tend it every time the code changes.
## What it does
1. **Picks the doc type** the reader needs: tutorial, how-to, reference, explanation, decision record (ADR), design doc, runbook or README.
2. **Checks facts in the code** before writing. Anything it could not check is marked `TBD`. It never writes secrets.
3. **Fills a template** and adds an owner and review dates, so anyone can tell if a doc is still true.
4. **Puts it in `docs/`** with a standard layout, and keeps the README's links and quick start current.
5. **Proposes a pull request.** Docs ship with the code they describe. A person reviews before merge.
6. **Learns** from your corrections through `LESSONS.md`.
## Quick start
You need: [Claude Code](https://docs.claude.com/en/docs/claude-code/overview).
**As a plugin:**
```
/plugin marketplace add eugeniughelbur/docgarden
/plugin install docgarden@docgarden
```
**Or copy the skill:**
```bash
git clone https://github.com/eugeniughelbur/docgarden.git
cp -R docgarden/skills/docgarden ~/.claude/skills/
```
Then, in any repo, say "document this", "write a runbook for the deploy", or "update the README". You can also run `/docgarden`.
## Templates
| Doc | When |
| -- | -- |
| [Tutorial](skills/docgarden/templates/tutorial.md) | Learn the system by doing it once |
| [How-to](skills/docgarden/templates/how-to.md) | Get one task done |
| [Reference](skills/docgarden/templates/reference.md) | Look up a setting, endpoint or limit |
| [Explanation](skills/docgarden/templates/explanation.md) | Understand why it works this way |
| [Decision record](skills/docgarden/templates/adr.md) | Record what was chosen and why |
| [Design doc](skills/docgarden/templates/design-doc.md) | Review a plan before building |
| [Runbook](skills/docgarden/templates/runbook.md) | Run, check or fix a live service |
| [README](skills/docgarden/templates/readme.md) | The front door of a repo |
## Built on
- [Diátaxis](https://diataxis.fr)
- [Architecture Decision Records](https://adr.github.io): Nygard and MADR
- [Google developer documentation style guide](https://developers.google.com/style)
- [Standard Readme](https://github.com/RichardLitt/standard-readme)
- [Write the Docs](https://www.writethedocs.org)
- [GitLab docs-as-code](https://docs.gitlab.com/development/documentation/testing/)
- [Google SRE](https://sre.google)
Full rules: [SKILL.md](skills/docgarden/SKILL.md).
## Contributing
Issues and pull requests are welcome. If docgarden got something wrong in your repo, open an issue with what it did and what it should have done. That becomes a new line in `LESSONS.md`.
## License
[MIT](LICENSE) © 2026 Eugeniu Ghelbur