technical-writing

Writes and audits READMEs, documentation pages, ADRs, and changelogs against source code.

22|Updated Sep 10, 2026
One-click install
npx skills add https://github.com/Lynricsy/HyperSkills --skill technical-writing-lynricsy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: technical-writing
Source: https://github.com/Lynricsy/HyperSkills/tree/main/skills/technical-writing
Command: npx skills add https://github.com/Lynricsy/HyperSkills --skill technical-writing-lynricsy

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Project documentation drifts out of sync with code, mixes document types on one page, and ships with untested examples and broken badges. This Skill classifies each document by type, verifies every claim against the source, and keeps READMEs, tutorials, references, ADRs, and changelogs accurate and readable. ## Core Features & Use Cases - Document classification and writing: Applies the tutorial / how-to / reference / explanation taxonomy with per-type rules, title patterns, and validation questions before any prose is written. - Docs-against-code audits: Establishes the source of truth first, settles every checkable claim (symbols, defaults, environment variables, links), and reports findings ranked by reader cost with cited lines on both sides. - README composition and portability: Covers first-screen layout, badge selection and failure modes, and a measured support matrix for how constructs render across forges and package registries. - Changelogs and ADRs: Turns commit logs into Keep a Changelog files with the six standard types and breaking-change markers, and writes ADRs that match the repository's existing convention. - Use Case: Before a release, ask for a docs audit: the Skill compares every documented command, parameter, and environment variable against the current source and returns a ranked findings report with proposed fixes. ## Quick Start Ask the agent to audit the project's README and documentation against the current source code and report every stale claim with its evidence.

Frequently Asked Questions about technical-writing

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

FAQPage Schema
How do I audit documentation against source code?

Establish the source of truth first (exports, definitions, dependency extras, environment variables), then settle every claim with a definite answer: commands, links, symbols, signatures, and defaults. Report findings ranked by reader cost, each citing a line in the docs and a line in the source.

How do I structure a README for a software project?

Put what the project is and a runnable quick start first, with nothing decorative above that line. Keep one home per fact, state the project status if not plainly supported, and choose only badges that answer a reader's question before reading.

What is the difference between a tutorial and a how-to guide?

A tutorial teaches a beginner through one path to one stated outcome, with every step ending in an observable result. A how-to guide solves an experienced reader's specific problem and may branch, but must be framed by the reader's goal, not by control names.

How do I write a changelog from a commit history?

Delete non-entries like merge commits, wip, lint, and version bumps, then group survivors by version under the six Keep a Changelog types. Rewrite each line for the upgrader with old and new names, mark breaking changes with the interface they break, and date versions from the tag list.

Why do broken badges pass link checkers in a README?

Badge services return HTTP 200 with the error text rendered inside the image, so status-code checks pass while readers see 'not found'. Fetch each badge URL and read its rendered title to detect failures.

When should I not write an architecture decision record?

Skip ADRs for reversible choices with obvious answers, decisions the code already states unambiguously, single-module implementation details, and plans. Write one only for decisions that are expensive to reverse and have a defensible alternative.