documenting

Detect documentation drift and update memories, changelogs, and README files.

4|1|Updated Nov 1, 2025
One-click install
npx skills add https://github.com/xtrm-dev/specialists --skill documenting
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documenting
Source: https://github.com/xtrm-dev/specialists/tree/main/.xtrm/skills/default/documenting
Command: npx skills add https://github.com/xtrm-dev/specialists --skill documenting

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires pyyaml, and includes scripts (resource) and references (resource) components.

What problem does it solve?

It removes the manual burden of keeping project documentation consistent across SSOT memories, changelogs, README guidance, and agent instructions after code changes.

Core Features & Use Cases

  • Drift Detection: Scans memories against recent file changes to find stale documentation before it spreads.
  • Documentation Updates: Creates or updates Serena memories with versioned frontmatter, changelog history, and autogenerated INDEX blocks.
  • Release Hygiene: Manages Keep a Changelog entries, release bumps, and validation so documentation stays structured and discoverable.
  • Use Case: After a feature or refactor lands, use this Skill to update the related memory, append a changelog entry, and validate the project docs in one workflow.

Quick Start

Ask the Documenting Skill to scan for documentation drift and update the relevant SSOT memory, changelog, and README for the completed change.

Frequently Asked Questions about documenting

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

FAQPage Schema
How do I detect documentation drift after code changes?

Documentation drift is detected by scanning Serena memories against recent file modifications to identify stale knowledge artifacts before they spread. This process finds outdated SSOT memories, changelogs, and README guidance that no longer match the updated codebase.

What is the best way to keep a changelog and README in sync with Serena memories?

Keeping changelogs and READMEs in sync involves updating Serena memories with versioned YAML frontmatter, appending structured changelog entries, and validating autogenerated INDEX blocks in one workflow. This ensures project documentation remains structured and discoverable after changes land.

How do I update project documentation for a completed refactor or bugfix?

Updating project documentation requires scanning modified files for drift, updating the relevant SSOT memory, and appending a changelog entry for the completed refactor or bugfix. This workflow enforces YAML frontmatter compliance and changelog ordering to maintain release hygiene.

Does the documentation update process require YAML frontmatter compliance?

Yes, documentation updates require YAML frontmatter compliance for Serena memories. The process enforces versioned frontmatter, autogenerated INDEX blocks, and proper changelog ordering to ensure all knowledge artifacts remain structured and valid.

When should I scan for documentation drift in my workflow?

Documentation drift scanning should be performed after a feature, refactor, bugfix, or architecture change lands. Running this process immediately after code modifications catches stale memories and outdated guidance before they propagate to other team members.

What are the limitations of automated documentation drift detection?

Automated drift detection requires pyyaml and works within Serena memory structures. It validates autogenerated INDEX blocks and YAML frontmatter but cannot infer semantic correctness of documentation content beyond detecting file modifications and structural compliance.