skills.rest
richardthe3rd
richardthe3rdCOMMUNITY
Explore all skills by this author →
GitHub

docs-and-writing

Govern documentation, ADRs, GitHub issues, commits, and PR messages for the Cambridge Beer Festival app.

2|3|Updated Nov 28, 2025
Search Tags:#documentation#conventional commits#adr#github issues#changelog generation#doc drift#pr linting
One-click install
npx skills add https://github.com/richardthe3rd/cambridge-beer-festival-app --skill docs-and-writing
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-and-writing
Source: https://github.com/richardthe3rd/cambridge-beer-festival-app/tree/main/.claude/skills/docs-and-writing
Command: npx skills add https://github.com/richardthe3rd/cambridge-beer-festival-app --skill docs-and-writing

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill eliminates inconsistent, scattered project documentation and ad-hoc writing that causes record drift, broken automated tooling (like changelog generation and PR linting), and poor contributor onboarding.

Core Features & Use Cases

  • Standardized docs taxonomy and lifecycle: Enforces a clear, indexed structure for all docs/ content, including active planning docs, archived materials, and ADRs, so every piece of project knowledge has a single, discoverable home.
  • House style for all project writing: Defines consistent formats for GitHub issues, commit messages, PR titles/descriptions, and Architecture Decision Records (ADRs) that align with CI gates and automated release note generation.
  • Drift correction and claim discipline: Tracks known inaccuracies in existing docs and enforces rules for what the project can publicly claim about its status (e.g., accessibility compliance, production readiness) to avoid misleading external stakeholders.
  • Use Case: When you need to file a bug report, write a commit message for a new feature, or decide if a technical decision requires an ADR, this Skill ensures you follow the project's established conventions so automated tools work correctly and future contributors can find information easily.

Quick Start

Use the docs-and-writing skill to draft a properly formatted GitHub issue for the bug you discovered in the festival data loading flow.

Frequently Asked Questions about docs-and-writing

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

FAQPage Schema
How do I standardize GitHub issues and commit messages to prevent documentation drift?▼

Prevent documentation drift by enforcing a standardized taxonomy and house style for all project writing, including commits and GitHub issues. This ensures automated CI gates and changelog generation workflows function correctly without broken references.

What is an ADR and when do I need to create one for my project?▼

An Architecture Decision Record (ADR) is a standardized document that captures technical decisions within a project. You need to create an ADR whenever a significant technical choice impacts the architecture, ensuring future contributors can discover and understand the rationale behind the system's design.

How do I format conventional commits so they pass PR linting and automated release workflows?▼

Format conventional commits by applying standardized house style rules for commit messages and PR titles. This alignment with CI gates ensures PR linting passes successfully and enables accurate, automated release note generation.

Why does broken project documentation cause contributor onboarding issues and CI failures?▼

Broken project documentation causes onboarding issues and CI failures because ad-hoc writing leads to record drift and misaligned references. Inconsistent docs taxonomy breaks automated tooling like changelog generation and makes project knowledge undiscoverable for new contributors.

How do I track known inaccuracies in existing docs to avoid misleading external stakeholders?▼

Track known inaccuracies in existing docs by applying drift correction procedures and enforcing claim discipline. This process actively monitors documentation errors and regulates what the project can publicly claim about its status, preventing misleading external stakeholders.

Related Skills

Explore More Software Engineering Skills→
ArvorCoArvorCo
96

constitution

Create or update a project constitution defining coding principles and governance rules.

Community
Advanced
Sumeet138Sumeet138
1

changelog-automation

Generate release notes and changelogs from commits and PRs.

Community
Advanced
dorgonmandorgonman
1

kano-commit-convention-skill

Lint commits against the Kano convention and generate changelogs.

Community
Basic
daisuke-tanabedaisuke-tanabe

sync-lint-docs

Remove ESLint and Prettier enforced code style rules from Markdown documentation.

Community
Intermediate