process-docs

Synchronizes repository documentation with code changes using audience-aware writing protocols.

Updated Dec 24, 2025
One-click install
npx skills add https://github.com/JoyJoin-Tech-Limited/JoyJoin_app_v0.1 --skill process-docs-joyjoin-tech-limited
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: process-docs
Source: https://github.com/JoyJoin-Tech-Limited/JoyJoin_app_v0.1/tree/main/.github/skills/process-docs
Command: npx skills add https://github.com/JoyJoin-Tech-Limited/JoyJoin_app_v0.1 --skill process-docs-joyjoin-tech-limited

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Code changes frequently leave documentation stale, duplicated, or missing entirely. This Skill enforces documentation discipline so READMEs, runbooks, architecture docs, and agent files stay synchronized with APIs, schemas, and architectural boundaries as they evolve. ## Core Features & Use Cases - Doc Surface Identification: Maps each change to the right audience and location, such as docs/runbooks for end users, docs/architecture for developers, and AGENTS.md for AI agents. - Update-Over-Duplicate Protocol: Updates existing canonical docs instead of creating parallel copies, adds cross-links, and stamps every doc with a Last updated date. - Validation Workflow: Verifies commands run, paths match the codebase, links resolve, and runs guardrail checks when AGENTS.md or skill files change. - Use Case: After changing an API schema, use this Skill to update the developer reference, refresh affected runbooks, deduplicate repeated sections, and flag stale docs for cleanup. ## Quick Start Ask the AI to update all documentation affected by your recent API or schema change and flag any stale docs.

Frequently Asked Questions about process-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I keep documentation in sync with code changes?▼

Identify the doc surface for each change, update the existing canonical doc rather than creating a new one, and validate that commands, paths, and links still work. Finish by stamping the doc with a Last updated date and checking downstream docs for duplicated content.

Where should different types of documentation live in a repo?▼

End-user docs belong in docs/runbooks or docs/guides, developer docs in docs/architecture and README files, AI agent instructions in AGENTS.md and skill files, and operational content in docs/ops or infra directories.

When should I update documentation during development?▼

Update docs as you write code, not after the feature is complete. Trigger doc updates whenever you change an API, schema, or architectural boundary, create a new skill or runbook, or modify workflows described in READMEs.

What are common documentation anti-patterns to avoid?▼

Avoid copy-pasting sections between docs, writing vague commands instead of exact ones like npm run build:server, mixing end-user and internal API content in one doc, and leaving docs without a Last updated date, which makes them appear stale.

When should I not create new documentation?▼

Skip doc work for one-line code changes with no contract impact, temporary scratchpad notes, or content that duplicates an existing canonical doc. In those cases, update or link to the source of truth instead.