Can I target specific areas of my project for documentation updates?

Yes, the skill supports targeted audits that allow you to focus on specific modules, such as a CLI tool or a dashboard, rather than the entire codebase.

Does this skill update user-facing documentation?

Yes, it reviews and updates files in the user-facing directory, including personas, use cases, FAQs, and Standard Operating Procedures (SOPs).

Why is recording a git anchor point mandatory?

Recording a commit anchor allows the skill to track exactly what has changed between sessions, enabling efficient incremental updates instead of requiring a full audit every time.

What is an incremental audit in the update-kb skill?

An incremental audit uses git diffs from a previous commit anchor to identify and update only the documentation affected by changes made since the last audit.

Where does the skill store audit records?

Audit notes and history are stored as permanent records within the .pmc/docs/6-references/ directory of your repository.

KB Update & Documentation Sync

Name: KB Update & Documentation Sync
Author: jayprimer

byjayprimer

学习与文档

Synchronizes project documentation and knowledge bases with the current codebase implementation through automated audits.

关于

The update-kb skill streamlines the maintenance of technical documentation by performing comprehensive audits of your source code to ensure that code maps, PRDs, patterns, and SOPs remain accurate. By establishing git-based anchor points, it allows for both exhaustive full-codebase reviews and efficient incremental updates that reflect recent feature changes. This tool is essential for teams undergoing major refactors or starting new development phases, ensuring that the project's documentation never diverges from the reality of the implementation.

主要功能

Git-based synchronization using commit anchors for tracking changes
Standardized audit logging and reporting within the repository
Automated full, incremental, and targeted codebase audits
Validation of user-facing documentation and persona use cases
Automated updates for code maps, PRDs, and implementation patterns
0 GitHub stars

使用场景

Maintaining documentation accuracy after major architectural refactors
Performing periodic monthly maintenance to prevent documentation rot
Synchronizing internal PRDs with actual implemented features before a release

关于

主要功能

Git-based synchronization using commit anchors for tracking changes
Standardized audit logging and reporting within the repository
Automated full, incremental, and targeted codebase audits
Validation of user-facing documentation and persona use cases
Automated updates for code maps, PRDs, and implementation patterns
0 GitHub stars

使用场景

Maintaining documentation accuracy after major architectural refactors
Performing periodic monthly maintenance to prevent documentation rot
Synchronizing internal PRDs with actual implemented features before a release