skills.rest
BRANDNEWSHVT
BRANDNEWSHVTOFFICIAL
Explore all skills by this author →
WebsiteGitHub

writing-documentation

Generate standardized documentation pages with YAML frontmatter and three-section guides.

Updated Aug 20, 2025
Search Tags:#architecture#documentation#writing#onboarding#readme#standards#api-docs
One-click install
npx skills add https://github.com/BRANDNEWSHVT/mercora --skill writing-documentation-brandnewshvt
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: writing-documentation
Source: https://github.com/BRANDNEWSHVT/mercora/tree/main/storefront-nuxt/.agents/skills/writing-documentation
Command: npx skills add https://github.com/BRANDNEWSHVT/mercora --skill writing-documentation-brandnewshvt

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation is often inconsistent, hard to discover, and quickly becomes stale, which slows onboarding, support, and cross-team collaboration. This guide provides a standardized framework for creating and updating documentation that remains accurate, accessible, and maintainable.

Core Features & Use Cases

  • Standard templates for READMEs, API docs, architecture docs, onboarding guides, and inline code comments.
  • Frontmatter-driven entry with required fields (name and description) to ensure clear discovery and context loading.
  • Quick-start workflow that lets a reader generate a complete, ready-to-use documentation page from a minimal prompt.

Quick Start

Create a new documentation page by using the standard template, fill in the frontmatter with a name and description, and start with the required sections.

Frequently Asked Questions about writing-documentation

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

FAQPage Schema
How do I standardize project documentation for onboarding and API docs?▼

Documentation templates reduce onboarding friction by enforcing a standardized framework: YAML frontmatter for discovery, a three-section guide body for structure, and a single actionable Quick Start sentence to bootstrap usage immediately.

How do I create a consistent README and architecture doc template?▼

You create consistent architecture docs by applying a standardized template that enforces required YAML frontmatter fields, a three-section guide body, and a single actionable Quick Start sentence to maintain structure and clarity.

What is the best way to write onboarding-friendly technical guides?▼

Writing onboarding-friendly guides requires a standardized framework that enforces required YAML frontmatter, a three-section guide body, and a single actionable Quick Start sentence to turn complex documentation into clear, accessible references.

Can I use this documentation framework for inline code comments and API docs?▼

Yes, the standardized documentation framework is explicitly applicable to READMEs, API docs, architecture docs, onboarding guides, and inline code documentation across software projects to ensure accurate and maintainable technical context.

Does standardized documentation require specific frontmatter fields?▼

Standardized documentation requires YAML frontmatter with name and description fields to ensure clear discovery, proper context loading, and standardized onboarding across all software projects.

Related Skills

Explore More Content & Communication Skills→
proyecto26proyecto26
42

requirements-scoping

Structure ambiguous system design prompts into functional requirements, non-functional constraints, and out-of-scope boundaries.

Official
Intermediate
dhruvinrsonidhruvinrsoni

knowledge-sharing

Create runbooks, onboarding guides, and wikis from team knowledge gaps.

Community
Intermediate
t-stringst-strings

Global Validation

Enforce centralized validation standards across repository code and CI pipelines.

Official
Basic
LiorCohenLiorCohen
39

docs-standards

Maintain SDD plugin documentation with frontmatter-driven metadata and markdown structure.

Community
Intermediate