documentation

Enforces writing quality guidelines and markdown formatting conventions for documentation files.

10|2|Updated Jan 24, 2026
One-click install
npx skills add https://github.com/nrdxp/predicate --skill documentation-nrdxp
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/nrdxp/predicate/tree/main/skills/documentation
Command: npx skills add https://github.com/nrdxp/predicate --skill documentation-nrdxp

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Inconsistent tone, bloated prose, broken links, and mixed document types make documentation hard to read and maintain. This Skill applies a fixed set of writing principles and markdown structural rules so every document you produce or edit stays clear, consistent, and portable. ## Core Features & Use Cases - Core Writing Principles: Enforces answer-first structure, active voice, sentence economy, terminology lock, scannable formatting, and bans filler phrases across all text output. - Divio Document Classification: Classifies documents as Tutorial, How-To, Reference, or Explanation and keeps each document to a single type with the correct tone and structure. - Markdown Audit Rules: Validates relative link portability, single-H1 header hierarchy, table alignment, consistent list symbols, and no trailing spaces, with an optional link-checking script. - Use Case: When editing a project README, the Skill flags preamble filler, fixes skipped header levels, converts absolute file paths to relative links, and confirms every cross-reference resolves. ## Quick Start Ask the agent to audit and rewrite the project README following the documentation skill's writing principles and markdown rules.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I write better technical documentation?

Lead with the answer, use active voice, keep one idea per sentence, and lock terminology so each concept has exactly one name. Classify the document using the Divio model as a tutorial, how-to, reference, or explanation before drafting.

What is the Divio documentation system?

The Divio model splits documentation into four types: tutorials for learning by doing, how-to guides for solving problems, reference for describing the system, and explanation for building understanding. Each document should be exactly one type.

How do I check markdown files for broken links?

Run the check_docs.py script referenced by the skill, which scans markdown files for broken local and external links. All cross-references should use relative paths in standard [text](url) format so they resolve from any host environment.

Can I use absolute file paths in markdown documentation?

No. Absolute file URIs like file:///var/home/... are forbidden because they break when projects are copied, symlinked, or cloned. Always use relative markdown paths between files and verify each link target resolves.

What markdown linting rules should documentation follow?

Use a single H1 per page, nest headers sequentially without skipping levels, align table columns, use a consistent list symbol, and leave no trailing spaces. These rules keep documents portable and consistent across host environments.