docs-and-writing

Community

Standardize project docs, issues, and commit writing.

Authorrichardthe3rd
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: docs-and-writing
Download link: https://github.com/richardthe3rd/cambridge-beer-festival-app/archive/main.zip#docs-and-writing

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 536,000+ vetted skills library on demand.