documentation

Select durable documentation artifacts and structure updates to match change surfaces.

Updated Apr 20, 2026
One-click install
npx skills add https://github.com/thistleknot/skills --skill documentation-thistleknot
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/thistleknot/skills/tree/main/documentation
Command: npx skills add https://github.com/thistleknot/skills --skill documentation-thistleknot

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It solves the problem of keeping project documentation consistent and correctly scoped when behavior changes, so teams don’t lose durable history or create redundant, drifting records.

Core Features & Use Cases

  • Artifact-selection protocol: Decide whether updates belong in the canonical document, a cumulative changelog, or a timestamped FIXES/CHANGES file based on change size and need.
  • Documentation lifecycle governance: Ensure documentation is updated in the same change as the underlying behavior shift, and retire or consolidate duplicates when they accumulate.
  • Format and traceability rules: Document impact clearly, include exact paths/commands/refs when it materially improves traceability, and keep documents scoped to one question.
  • Validation-aware extensibility notes: When a feature variant is validated, document extensibility capability for future developers and link to evidence when major research was involved.

Quick Start

Use the documentation skill when you need to update README/changelog/docs and determine whether to write a canonical update, a cumulative entry, or a timestamped fixes-applied document for a specific change.

Frequently Asked Questions about documentation

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

FAQPage Schema
When should I use a cumulative changelog versus a timestamped release notes file?

Use a cumulative changelog for ongoing minor updates and a timestamped release notes file for major refactors requiring validation records. This artifact-selection protocol prevents documentation drift by matching the record format to the true change surface and audience scope.

How do I structure documentation updates to maintain traceability after a refactor?

Structure documentation updates using impact-first formatting and include exact commands, file paths, and references. This documentation traceability approach ensures validation records clearly map behavior changes to their underlying artifacts for future developers.

What is the best way to prevent duplicate documentation updates across multiple audiences?

Apply documentation lifecycle governance by scoping each document to one question and updating it within the same change window as the behavior shift. Retire or consolidate duplicate records immediately to prevent drift across audiences.

Do I need to document extensibility notes when validating a feature variant?

Yes, when a feature variant is validated, you must document the extensibility capability for future developers. Link to validation evidence directly within the release notes or canonical document when major research is involved.

How do I decide between updating the canonical README or creating a separate fixes-applied document?

Decide whether an update belongs in the canonical README or a separate fixes-applied file based on change size. Use the artifact-selection protocol to route substantive refactors to timestamped files while keeping canonical documents scoped to permanent behavior.