write-project-docslisted
Install: claude install-skill a-novel-kit/stack
# Project Docs
This skill governs the three root-level Markdown files that describe a project to external
readers: `README.md`, `SECURITY.md`, `CONTRIBUTING.md`. They are the first thing visitors see,
setting expectations for usage, security contact, and how to contribute, so they must be accurate,
scannable, and consistent across all Agora services.
They carry the **global picture** — the architecture, the layer split, the principles behind the
shape of the system — which code comments defer to instead of re-explaining the system from inside
one source file (see `document-code`). Keep that wide-angle view current, so the comments in the code
can stay local and specific.
`README.md` is a reference **entrypoint**: how to install, configure, and call the project, plus that
global picture. Closer to an extension of the code comments than to a guide, it follows the section
order below rather than a narrative. `CONTRIBUTING.md` and `SECURITY.md` are **guides**: they walk a
reader through a process, as do the pages they link (onboarding, a board-lifecycle walkthrough).
The skill has two modes, detected in Phase 2: **scaffold** generates a missing file from the
templates here, **update** edits the relevant section of an existing one in place.
Separate concerns:
- `CODE_OF_CONDUCT.md` — **not managed by this skill.** Copy the Contributor Covenant
verbatim from <https://www.contributor-covenant.org/version/2/1/code_of_conduct.md>
when setting up a new project and do not edit