techwriter-core

Maintains project documentation in docs/ through a fixed pipeline of edits, humanizer pass, validation, and index updates.

Updated Jun 2, 2026
One-click install
npx skills add https://github.com/lfuuu/claude-rules --skill techwriter-core-lfuuu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: techwriter-core
Source: https://github.com/lfuuu/claude-rules/tree/main/global-skills/techwriter-core
Command: npx skills add https://github.com/lfuuu/claude-rules --skill techwriter-core-lfuuu

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Code changes often leave documentation stale or inconsistent. This Skill defines the invariant core of a technical-writer role that is the single agent allowed to write into docs/, keeping documentation synchronized with code changes in the same task. ## Core Features & Use Cases - Fixed documentation pipeline: context loading, edits, humanizer pass, markdownlint and link validation, index updates, and a structured report. - Four operating modes: code-change (sync docs after code edits), review (consistency audit without edits), validate (linters only), and new-doc creation from templates. - Strict style and NEVER rules: YAML frontmatter on every article, kebab-case naming, clickable file links, no AI-marker words, no credentials in examples, and no editing of code or running tests. - Use Case: After a backend agent changes an API endpoint, the wrapper skill invokes this core to update the affected docs pages, re-render related diagrams, run the humanizer, validate links and frontmatter, and return a structured report to the teamlead. ## Quick Start Import this core from a project wrapper by adding a line stating that the techwriter-core SKILL.md applies, then invoke the techwriter role with a mode such as code-change or review.

Frequently Asked Questions about techwriter-core

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

FAQPage Schema
How do I keep documentation synchronized with code changes?

Invoke the code-change mode after any behavior change, passing the modified files, task, area, and changes. The skill maps code to affected documents, edits them, runs a humanizer pass, validates links and frontmatter, and updates the docs indexes in the same task.

How do I audit a docs folder for consistency with the codebase?

Use the review mode, which performs a full read-only check of docs/ against the code and returns a report without making edits. The validate mode runs only the linters: markdownlint, link checking, and frontmatter verification.

Can this skill edit source code or run tests?

No. The skill is explicitly forbidden from editing code, tests, migrations, or configs, and from running tests, builds, deploys, or git operations. It writes only inside docs/ and returns a structured report to the calling agent.

What frontmatter is required for documentation articles?

Every article except README.md must start with YAML frontmatter containing title, status (draft, review, or stable), and last-updated in YYYY-MM-DD format. A draft older than 30 days without an updated last-updated field triggers a warning during review.

When is the humanizer pass required for documentation?

The humanizer pass is mandatory for new articles and substantially reworked sections before publication. It is skipped for factual updates like endpoint or schema changes, link or frontmatter fixes, and read-only review or validate runs.

What are the limitations of the techwriter-core skill?

It is not invoked directly and requires a project wrapper that defines the docs/ structure, code-to-document mapping, page templates, and domain rules. It also cannot orchestrate other agents, spawning only utility skills like humanizer and diagram.