dual-track-docslisted
Install: claude install-skill wsagency/WS-Claude-marketplace
# Dual-Track Documentation Convention
Documentation belongs in one of two parallel tracks based on audience:
| Track | Folder | Audience | Examples |
|---|---|---|---|
| User | `docs/` | External consumer — end-users, library clients, API consumers, plugin users | Tutorials, how-to guides, public API reference, conceptual explanations |
| Internal | `dev-docs/` | Internal contributor — maintainers, dev team | Architecture, ADRs, runbooks, internal module reference, code conventions |
The distinction is **audience**, not technical complexity. An API reference for external consumers belongs in `docs/`. A reference for internal modules belongs in `dev-docs/`.
## Standard layout
```
<project>/
├── README.md ← landing, links to both tracks
├── CHANGELOG.md ← single source (Keep-a-Changelog)
├── CONTRIBUTING.md ← thin router → docs/contributing + dev-docs/development
├── AGENTS.md ← agent instructions (canonical, agent-neutral)
├── CLAUDE.md ← thin @AGENTS.md import
│
├── docs/ ← USER docs (Diátaxis, VitePress-portable)
│ ├── index.md
│ ├── tutorials/
│ ├── how-to/
│ ├── reference/
│ ├── explanation/
│ ├── changelog.md ← MIRROR of root CHANGELOG.md
│ ├── contributing.md
│ └── release-notes/
│
└── dev-docs/ ← INTERNAL docs
├── index.md
├── architecture.md ← THIN when an OpenWiki exists: curated boundaries
│