Generate ikigai project documentation with structured frontmatter and cross-references.
npx skills add https://github.com/mgreenly/ikigai --skill docs-mgreenly
Please help me install this Agent Skill. Skill: docs Source: https://github.com/mgreenly/ikigai/tree/main/.claude/library/docs Command: npx skills add https://github.com/mgreenly/ikigai --skill docs-mgreenly
Documenting the ikigai project can be inconsistent and hard to maintain. This skill provides a concise, opinionated set of guidelines to produce clear, user-facing documentation that is easy to navigate and reuse across topics.
Create a new documentation topic following the ikigai docs guidelines and structure.
High-intent search queries and answers about installing and using this skill.
Feature documentation should follow a structured progression of goals, usage, and examples. Organize files with one major topic per file, using prescribed sections like Overview, Quick Start, and Details to improve findability and maintenance.
Developer docs are easier to maintain when you use a one-topic-per-file organization with structured frontmatter. Include clear headings, code examples, and tables to prescribe style and structure across internal documentation.
Cross-references reduce duplication in project documentation by linking to related docs and project references instead of repeating content. This promotes reuse across topics and keeps architecture references consistent.
Security considerations should be included in user guides whenever deployment guidance is relevant. Calling out security needs during documentation authoring ensures users understand deployment constraints and safe usage.
Yes, this documentation approach applies to architecture references alongside internal developer docs and user guides. It supports structured frontmatter and cross-references across docs and project topics for consistent quality.
Unstructured documentation becomes inconsistent and hard to maintain for cross-functional teams. Without an opinionated set of writing guidelines, findability decreases and content duplication increases across related topics.
shawn-sandyPackage Claude Code skills into versioned ZIP archives with generated documentation.
e0ipsoBootstrap a knowledge base by scanning markdown files and writing new node files.
georgekhananaevEnforce consistent Markdown syntax across documentation and README files.
yonatangrossGenerate technical documentation templates for READMEs, ADRs, and OpenAPI 3.1 APIs.
