k-doc

Generate ProjectK ADR, DDR, and system documentation with mandatory sections and frontmatter.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/ewertonxyz/ProjectK --skill k-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: k-doc
Source: https://github.com/ewertonxyz/ProjectK/tree/main/.claude/skills/k-doc
Command: npx skills add https://github.com/ewertonxyz/ProjectK --skill k-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation and updating of ProjectK documentation according to specific rules, saving time and ensuring consistency across all documentation.

Core Features & Use Cases

  • Documentation Generation: Automatically create ADRs, DDRs, decision records, and system documentation based on required sections and frontmatter.
  • Rule Adherence: Ensures adherence to Documentation-Rules ADR (architecture) / DDR (design-art decision) standards.
  • Use Case: When asked to write an ADR, DDR, decision record, or any Docs/ page, use k-doc to generate the required documentation with all necessary elements.

Quick Start

Run the k-doc skill with the argument 'adr MyNewADR' to create a new architecture decision record.

Frequently Asked Questions about k-doc

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

FAQPage Schema
How do I automate ProjectK documentation creation for ADRs and DDRs?

You can automate ProjectK documentation creation by running the k-doc skill with specific arguments like 'adr' or 'ddr' to generate structured decision records. It automatically includes mandatory sections, frontmatter, and numbering while adhering to Documentation-Rules standards.

What is the best way to ensure my system documentation follows Documentation-Rules standards?

To ensure system documentation follows Documentation-Rules standards, use an automated documentation skill that enforces required sections, frontmatter, and numbering. The k-doc skill automatically validates and generates compliant ADRs, DDRs, and system documents.

How do I generate a new architecture decision record with mandatory frontmatter?

To generate a new architecture decision record with mandatory frontmatter, execute the k-doc skill using the 'adr' argument followed by your record name. It automatically structures the document with all required sections and numbering.

Does the k-doc skill require manual file manipulation to create decision records?

Yes, the k-doc skill requires script execution and file manipulation to complete documentation tasks. While it automates the structuring of ADRs and DDRs, users must execute the scripts to generate and update the documentation files.

Can I use k-doc to update existing system documentation or only to create new files?

You can use k-doc to both create and update existing ProjectK documentation. It automates the generation of new ADRs, DDRs, and system documents while ensuring any updates maintain adherence to Documentation-Rules and mandatory section requirements.

When should I use automated documentation generation instead of writing decision records manually?

You should use automated documentation generation when you need to create multiple ADRs, DDRs, or system documents efficiently while ensuring strict consistency. It eliminates manual formatting errors and enforces adherence to Documentation-Rules across all documentation.