Doc Start

Write or reorganize repository documentation using a navigation-first structure. `doc_Start.md` is the repo entry point. Large topic areas get their own `linker_<Topic>.md` file. Every file routes — none of them dump.

jav-ed 2a0465b 7 files · 4.3 KB Updated

File contents

doc-start

Write docs so an agent can orient itself without being forced to read everything. The goal is context efficiency: doc_Start.md gives the agent a clear enough overview that it can decide what is relevant to its current task and skip everything else. The docs system is a map, not a dump — the agent navigates it, it does not consume it.

References

  • Writing rules — how to write doc_Start.md and linker files correctly
  • Folder guidance — which top-level folders to use and what each one is for
  • Process — steps to follow when creating or improving repo docs
  • doc_Start template — scaffold for the repo entry point
  • Linker template — scaffold for sub-area linker files

jav-ed/skill_Manag/tree/main/internal/testdata/vault/doc-start commit 2a0465b244

Frequently asked questions

npx skillmds@latest add jav-ed/doc-start-2