1natsu-document-harness

Automate harness documentation updates across CLAUDE.md, rules, docs, and READMEs.

1|Updated Oct 30, 2017
One-click install
npx skills add https://github.com/1natsu172/dotfiles --skill 1natsu-document-harness
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: 1natsu-document-harness
Source: https://github.com/1natsu172/dotfiles/tree/main/.agents/skills/1natsu-document-harness
Command: npx skills add https://github.com/1natsu172/dotfiles --skill 1natsu-document-harness

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the process of generating and updating harness-related documentation across a project after code changes, ensuring consistency between CLAUDE.md, .claude/rules/, docs/, and feature READMEs.

Core Features & Use Cases

  • Analyze changes with git diff/log to determine impacted packages, directories, and artifacts such as plan files and design memos.
  • Survey existing documentation and adjust structure, tone, and references to maintain consistency and avoid duplication.
  • Prioritize updating existing docs first, refresh CLAUDE.md references, and create new docs only when required, providing a repeatable workflow for post-change documentation.

Quick Start

Run the harness after implementing changes to regenerate and align the project's harness documentation.

Frequently Asked Questions about 1natsu-document-harness

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

FAQPage Schema
How do I keep project documentation aligned with code changes automatically?

To keep documentation aligned with code changes automatically, you can use a documentation harness that analyzes git diff and log outputs to identify impacted packages, then orchestrates updates across CLAUDE.md, .claude/rules/, docs/, and feature READMEs to reflect the current implementation.

What is the best way to update CLAUDE.md and feature READMEs after a new implementation?

The best way to update CLAUDE.md and feature READMEs post-implementation is to run an automated documentation workflow that surveys existing docs first, adjusts references to avoid duplication, and only creates new documentation files when structurally required.

How does a documentation harness maintain consistency across multiple project directories?

A documentation harness maintains consistency by surveying existing documentation structure, tone, and references across multiple directories, applying change-scoping and consistency checks to ensure all artifacts accurately reflect the latest architecture updates without duplication.

Do I need to manually scope documentation updates when adding a new feature?

You do not need to manually scope documentation updates for new features, as the harness automatically outlines steps for change-scoping by analyzing git history to determine impacted packages, directories, and artifacts like plan files and design memos.

When should I avoid creating new documentation files during a project refresh?

You should avoid creating new documentation files when existing docs can be updated to reflect the code changes, as the harness prioritizes refreshing existing references in CLAUDE.md and docs/ first, generating new files only when absolutely required.