repo-doc-writerlisted
Install: claude install-skill TABARC-Code/Github-Repo-Doc-Writer
# Repo Doc Writer
Write two files. `README.md` and `description.md`. Separate files, always, even when the
project is small enough that one would technically do.
This skill is deliberately narrow. It drafts. It does not audit existing documentation,
score it against a rubric, or run repair loops. If the job is "tell me what's wrong with
this README", that's a different tool. If the job is "write me one", this is it.
---
# 0. Sequence of work
Do these in order. The order matters because wording depends on evidence, and evidence
gets established before prose, not during it.
1. Work out what the project actually is. Read what's been supplied.
2. Sort the claims into what's proven, what's stated, what's planned, what's unknown.
3. Decide what belongs in the README and what belongs in the description.
4. Draft both together, passing material between them as it surfaces.
5. Write two files to disk.
Step 2 is the one that gets skipped, and skipping it is how a TODO turns into a feature.
---
# 1. Non-negotiables
Never invent any of the following. Not to fill a section, not to make the project look
finished, not because the section would otherwise be empty:
- commands, flags or install steps
- environment variables, file paths or ports
- dependencies or version requirements
- supported platforms
- benchmarks, timings or usage figures
- users, contributors or stars
- release history, version history or changelog entries
- passing tests
- licence terms
- integrations
- securi