skills.rest
cliveportman
cliveportmanCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

docs-conventions

Define and enforce documentation conventions for the docs/ directory.

1|Updated Oct 13, 2024
Search Tags:#templates#documentation#adr#conventions#naming#docs-structure
One-click install
npx skills add https://github.com/cliveportman/way-of-the-goat --skill docs-conventions-cliveportman
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-conventions
Source: https://github.com/cliveportman/way-of-the-goat/tree/main/.claude/skills/docs-conventions
Command: npx skills add https://github.com/cliveportman/way-of-the-goat --skill docs-conventions-cliveportman

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Formats and naming conventions for project documentation stored in the docs/ directory, ensuring consistency across features, issues, and Architecture Decision Records.

Core Features & Use Cases

  • Defines the standard folder structure for docs/features, docs/issues, and docs/decisions.
  • Specifies naming conventions (e.g., kebab-case) and required frontmatter for new documents.
  • Provides templates for common document types (research.md, plan.md, retro.md, investigation.md, fix-plan.md, ADRs) to streamline collaboration.

Quick Start

Read and apply these conventions when creating new documentation files in the docs/ directory.

Frequently Asked Questions about docs-conventions

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

FAQPage Schema
What is the best way to standardize project documentation structure?▼

Standardizing project documentation structure requires defining a cohesive docs-conventions framework that applies consistent folder layouts, naming conventions, and document templates across the docs/ directory.

How do I organize Architecture Decision Records in my docs directory?▼

To organize Architecture Decision Records in your docs directory, place them in docs/decisions and apply directory layout and ADR numbering rules to enforce consistent tracking and retrieval of decisions.

What naming conventions should I use for feature and issue documentation?▼

Feature and issue documentation naming conventions should use kebab-case formatting. Apply these naming rules alongside required frontmatter to maintain consistency across the docs/features and docs/issues directories.

What templates do I need for research, plan, and retrospective documents?▼

Templates for research, plan, retrospective, investigation, fix-plan, and ADR documents provide standardized frontmatter and structural layouts. Using these templates streamlines collaboration and enforces documentation consistency.

Does this documentation framework require specific frontmatter in SKILL.md?▼

Yes, the documentation framework requires the SKILL.md frontmatter to include a name and description. This mandatory frontmatter ensures the docs-conventions are properly defined and discoverable within the project.

When do I need to apply documentation conventions to my project?▼

You need to apply documentation conventions when creating new files in the docs/ directory for features, issues, and decisions. Applying these rules ensures standardized formatting and structure across all project documentation.

Related Skills

Explore More Content & Communication Skills→
hyperbolic-chyperbolic-c
5

requirement-parser

Parse YAML frontmatter from Markdown requirement files and validate required fields.

Community
Intermediate
timbuchingertimbuchinger
1

architecture-documenter

Generate and maintain architecture documentation with Mermaid diagrams under docs/architecture/.

Community
Basic
dthuy62dthuy62

ck:project-organization

Organize project files into standardized folders with kebab-case naming and markdown templates.

Community
Advanced
HellKaiser45HellKaiser45

documentation-and-adrs

Capture architectural decisions and design rationales in ADR templates.

Community
Intermediate