docs

Standardize ikigai project documentation with YAML frontmatter and structured guidelines.

Updated Mar 4, 2026
One-click install
npx skills add https://github.com/multicam/ikigai-rev --skill docs-multicam
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/multicam/ikigai-rev/tree/main/.claude-i/library/docs
Command: npx skills add https://github.com/multicam/ikigai-rev --skill docs-multicam

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Guidelines for writing user-facing documentation in the ikigai project help teams produce consistent and high-quality materials, reducing ambiguity and improving usability.

Core Features & Use Cases

  • Structured frontmatter with name and description to enable discovery and activation.
  • A three-section description including what problem is solved, core features, and a quick start to guide immediate use.
  • A concise Quick Start instruction sentence that triggers an initial action without code.

Quick Start

Draft a complete documentation page following these guidelines.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I write consistent project documentation with YAML frontmatter?

To write consistent project documentation, include YAML frontmatter with name and description fields, followed by a three-section body covering the problem solved, core features, and a concise Quick Start instruction.

What is the required structure for user-facing documentation guidelines?

User-facing documentation guidelines require a three-section description format: what problem is solved, core features and use cases, and a single-sentence Quick Start that triggers an immediate action without code.

How do I create a Quick Start instruction for technical documentation?

Create a Quick Start instruction by writing a single, concise sentence that triggers an initial action, such as drafting a complete documentation page, without including any code snippets.

Do I need YAML frontmatter for architecture notes and project docs?

Yes, YAML frontmatter with name and description fields is required for architecture notes and project docs to enable consistent authoring and discovery across the documentation.

What is the best way to standardize documentation authoring for engineers and writers?

Standardize documentation authoring by applying structured guidelines that require consistent frontmatter, a three-section description layout, and a single-sentence Quick Start across all user-facing materials.

Can I use code snippets in the Quick Start section of the documentation?

No, the Quick Start section must be a concise single-sentence instruction that triggers an initial action without relying on code snippets to guide immediate use.