documentation-manager

Solid

Use when writing or reviewing pynchy documentation, deciding where to document things, updating the docs, checking doc consistency, or fixing broken links. Covers information architecture, writing philosophy, tree-shaped navigation, doc-code coupling, no hard-coded usernames, extensibility framing for pluggable subsystems, and when to add code comments.

Data & Documents 10 stars 2 forks Updated today MIT

Install

View on GitHub

Quality Score: 79/100

Stars 20%
35
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# Documentation Manager Helps decide where to document things and maintain consistency across Pynchy docs. ## Style Guide - Write for a **user trying to achieve a goal**. Don't chronicle the evolution of the codebase. Don't go into unnecessary technical details that are not relevant to the user's goal. - Follow the [Google Style Guide](https://developers.google.com/style). Write in the present tense. Don't use "we" or "they". Write in the active voice. Don't use "is" or "are". - Read `docs/contributing/contributing-docs.md` for the full documentation philosophy and information architecture rules. ## Where to Document What Quick decision tree: **New feature?** - Architecture decision → `docs/architecture/` (find the relevant topic file, or create a new one) - Installation requirement → `docs/install.md` - Security implication → `docs/architecture/security.md` - Development workflow change → `.claude/skills/pynchy-dev/SKILL.md` **Bug fix?** - If it needs install change → `docs/install.md` - Usually: No doc update needed **Refactoring?** - If user-visible → Update relevant docs - If internal only → No doc update ## File Purposes | File | What Goes There | |------|-----------------| | `README.md` | Philosophy, quick start, high-level overview | | `docs/install.md` | Complete installation guide | | `docs/architecture/security.md` | Security model, threat analysis | | `docs/architecture/index.md` | Architecture overview and links to topic pages | | `docs/architecture/*.md...

Details

Author
crypdick
Repository
crypdick/pynchy
Created
5 months ago
Last Updated
today
Language
Python
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Listed

ami-doc-manager

Comprehensive documentation manager. Automatically detects whether to architect new project documentation from scratch or synchronize existing documentation with code changes.

1 Updated today
AnaCataVC
Data & Documents Solid

write-docs

Write and edit project docs (README/markdown) as a glossary of principles, not a mirror of the code. Use when creating or revising a README; when a doc enumerates exact scenes, scenarios, helpers, class ids, file lists, or command/flag matrices the code already holds; when trimming narrative or changelog out of a doc; or when deduplicating overlapping docs and wiring a root doc to its sub-docs.

41 Updated 2 days ago
dzhng
Data & Documents Solid

project-documentation

Creates and maintains project documentation for features, systems, and components. Use when documenting how a feature, system, or component works — including writing, updating, or organizing docs. Does not scan or detect the project's technology stack — use project-discovery for repository analysis and config detection. Does not create architectural decision records — use architectural-decision-record for ADRs. Does not create or update coding standards — use coding-standard instead. Does not generate PR descriptions — use update-pr-description for that. Does not produce runbooks for operational scenarios — use runbook for that. Does not rewrite existing prose for readability — use edit-for-readability for that. Does not produce an ephemeral, understand-now overview of code or a PR — use code-overview for that.

128 Updated today
testdouble