create-doc

Create a new document with title and description fields.

78|252|Updated Feb 7, 2024
One-click install
npx skills add https://github.com/hashicorp/web-unified-docs --skill create-doc
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: create-doc
Source: https://github.com/hashicorp/web-unified-docs/tree/main/content/well-architected-framework/docs/.claude/skills/create-doc
Command: npx skills add https://github.com/hashicorp/web-unified-docs --skill create-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates the creation of new documentation files with a consistent structure, boilerplate content, and frontmatter aligned to WAF standards, saving time and reducing errors in early document setup.

Core Features & Use Cases

  • Template-driven creation: Generates a new doc file with proper frontmatter, title, and description based on a simple path and optional metadata.
  • Structure scaffolding: Applies a canonical document skeleton including the Why section, resource placeholders, and cross-references.
  • Use Case: A content team needs to spin up new topic pages quickly for a product area while maintaining uniform metadata and layout.

Quick Start

Run the /create-doc command with a target path, for example: /create-doc docs/cicd/pipelines.mdx --title "CI/CD Pipelines" --description "Guide for building automated pipelines" --type howto

Frequently Asked Questions about create-doc

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

FAQPage Schema
How do I create new documentation files with consistent frontmatter automatically?▼

To create documentation files with consistent frontmatter automatically, use a template-driven command that applies path-based workflows to generate standardized metadata and content skeletons for new topics.

What is the best way to scaffold documentation structure for a new topic page?▼

Scaffolding documentation structure for a new topic page involves applying a canonical document skeleton that includes a Why section, resource placeholders, and cross-references aligned to documentation standards.

How do I generate boilerplate content for MDX documentation files?▼

Generating boilerplate content for MDX documentation files requires running a creation command with a target path and optional metadata like title and description to apply proper templates and frontmatter.

Does this documentation creation approach support WAF standards for frontmatter?▼

Yes, this documentation creation approach supports WAF standards by ensuring frontmatter, template application, and content scaffolding are integrated directly into the generated target file.

Can I use templates to spin up multiple howto documentation pages quickly?▼

You can use templates to spin up multiple howto documentation pages quickly by executing a creation command with a type parameter, ensuring uniform metadata and layout across the content team.

What are the limitations of path-based workflows for documentation generation?▼

Path-based workflows for documentation generation focus on creating new files with boilerplate content and frontmatter, meaning they do not modify existing documents or validate internal content accuracy beyond structural scaffolding.