paishu-ai/pai-zong-nb-v5.8/52-docs-index-maintainer
Claude Code and agent skill by paishu-ai/pai-zong-nb-v5.8
- community
Checking that the SKILL.md file is still in the repository.
Use when creating, moving, renaming, deleting, auditing, or reorganizing documentation files, or when .ai_project.md Docs Index must show what each docs/ file is for and when future Codex sessions should read it.
Install
npx vskill@latest install paishu-ai/pai-zong-nb-v5.8/52-docs-index-maintainerSKILL.md
The same SKILL.md was published earlier as paishu-ai/pai-zong-nb-v5.8/52-docs-index-maintainer.
Docs Index Maintainer
Purpose
Keep .ai_project.md as a reliable map to docs/. Future sessions should know which document to read for a task without scanning every file.
Use with project-assistant whenever docs files change.
Required Index Fields
Each Docs Index entry should contain:
- Path
- Purpose
- Read When
- Related Area
- Last Updated or Status when useful
Recommended compact format:
Workflow
- List existing docs files.
- Compare against
.ai_project.mdDocs Index. - Add missing docs entries.
- Remove or update entries for moved/deleted docs.
- Split vague entries into precise task-readable descriptions.
- Keep index concise; detailed content belongs in the docs file.
- If docs are reorganized, update references inside related docs when obvious.
Bundled Resources
scripts/generate-docs-index.ps1: generates a Markdown Docs Index from currentdocs/**/*.md.
Run example:
Paste or merge the generated table into .ai_project.md, then refine Purpose fields if needed.
Category Rules
| Folder | Purpose | |
|---|---|---|
docs/architecture/ | system structure, module boundaries, data flow | |
docs/features/ | feature behavior, user flows, acceptance notes | |
docs/api/ | endpoints, schemas, auth, errors, compatibility | |
docs/database/ | schema, migrations, indexes, transactions | |
docs/desktop/ | Tauri/native commands, permissions, updater | |
docs/deployment/ | env vars, build, packaging, release, rollback | |
docs/decisions/ | ADRs and significant tradeoffs | |
docs/maintenance/ | technical debt, known issues, refactor candidates | |
docs/roadmap/ | roadmap and feature lifecycle | |
docs/changelog/ | durable development history and release notes |
Quality Bar
Good index entry:
Bad index entry:
Avoid
- Leaving new docs unindexed.
- Using broad “project docs” descriptions that do not guide retrieval.
- Turning Docs Index into a changelog.
- Duplicating full docs content inside
.ai_project.md.
Security
- Security scanPassed, 100 of 100Pattern checks on the skill's files.
- Model reviewPassed
Quality evaluation
- Task evaluationNot runNo evaluation yet. Run one in Skill Studio.
Source
- SKILL.md in the repositoryCheckingskills/52-docs-index-maintainer/SKILL.md
Popularity
- Repository stars
- 1
- Repository forks
- 1
- 7-day trend score
- 8
Stars and forks are for the whole GitHub repository, not this skill alone. Not refreshed yet.
Works with
Any agent vskill installs to: 56 targets in all. These 39 have a page on this site.
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Codex
- Gemini CLI
- Cline
- Amp
- Roo Code
- Goose
- Continue
- Kilo Code
- Junie
- Trae
- OpenHands
- Qwen Code
- AI Agent
- Tabnine Chat
- Sourcegraph Cody
- Amazon Q
- Firebase Genkit
- Sweep
- Devin
- Phind
- Mentat
- Claude Desktop
- Aider
- GPT Pilot
- Plandex
- bolt.new
- v0
- Replit Agent
- Anse
- TypingMind
- BetterChatGPT
- LibreChat
- Warp AI
- Pieces
- Fig AI
Embed badge
[](https://verified-skill.com/skills/paishu-ai/pai-zong-nb-v5.8/52-docs-index-maintainer)