# Documentation Autowriter

> Generates and keeps README.md and ARCHITECTURE.md in sync with components, stores, and agents so judges can quickly evaluate the project.

- Skill: `tomevault-io/documentation-autowriter` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/documentation-autowriter`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/documentation-autowriter/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Docs & Writing
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/documentation-autowriter

---


# Documentation Autowriter

When to use this skill

- Use whenever you add new components, agents, or stores and want docs updated for reviewers.
- Triggered by prompts like "update README" or "generate architecture overview".

Instructions

1. First Step: Scan `src/components/` and `src/stores/` to build a component map and store summary.

2. Second Step: Render `README.md` with development steps, demo instructions (how to use Copilot CLI agents), and a brief feature summary.

3. Third Step: Produce `ARCHITECTURE.md` documenting Atomic Design layout, store relationships, and agent/skill list for the judges.

Examples

- README includes: setup, run, test, demo CLI steps (`gh copilot ask "Find endorsers for my paper"`).

Notes

- Keep automated docs human-editable and include pointers to extend the output (how to add a new component/module).

---
> Converted and distributed by [TomeVault](https://tomevault.io/claim/cargdev) — claim your Tome and manage your conversions.
<!-- tomevault:4.0:skill_md:2026-04-14 -->

