documentation

Standardize repository markdown documentation conventions and lifecycle management.

Updated Apr 21, 2026
One-click install
npx skills add https://github.com/VladlenFilimonov/hex-kotlin-monolith-template --skill documentation-vladlenfilimonov
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/VladlenFilimonov/hex-kotlin-monolith-template/tree/main/.claude/skills/documentation
Command: npx skills add https://github.com/VladlenFilimonov/hex-kotlin-monolith-template --skill documentation-vladlenfilimonov

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill standardizes repository documentation conventions, templates, and lifecycle practices to ensure consistency across all markdown docs, from feature plans to ADRs.

Core Features & Use Cases

  • Enforces a consistent frontmatter schema (name, description, date, type, status)
  • Provides a repeatable structure for plans, ADRs, and guides, with clear lifecycle and review processes
  • Automates quick-start templates and organization rules for new documentation

Quick Start

Create or update a Markdown document following the repository's documentation conventions.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I standardize markdown documentation conventions across a repository?

Standardize markdown documentation by enforcing a consistent frontmatter schema, naming conventions, and progress tracking to maintain uniform structure across feature plans, specs, and architecture docs.

What frontmatter fields should architecture docs and ADRs include?

Architecture docs and ADRs should include frontmatter fields for name, description, date, type, and status to ensure consistent metadata tracking and lifecycle management across all repository markdown files.

How do I manage the documentation lifecycle for feature plans and guides?

Manage the documentation lifecycle by applying repeatable structures with clear review processes and progress tracking to feature plans and guides, ensuring proper organization from creation through completion.

What is the best way to organize new markdown docs in a repository?

Organize new markdown docs by applying repository documentation conventions that automate quick-start templates and enforce organization rules, providing a repeatable structure for new files.

Can I use this approach to standardize ADRs and specs without external dependencies?

You can standardize ADRs and specs without external dependencies by applying self-contained markdown templates and frontmatter formats that enforce naming conventions and lifecycle practices internally.

When do I need standardized documentation templates for my repository?

You need standardized documentation templates when your repository requires consistent frontmatter formats, naming conventions, and lifecycle management across multiple markdown document types like plans, ADRs, and guides.