documentation

Write all planning, proposal, and note outputs to structured .md files.

1|Updated Nov 15, 2022
One-click install
npx skills add https://github.com/BfdCampos/dotfiles --skill documentation-bfdcampos
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation
Source: https://github.com/BfdCampos/dotfiles/tree/main/claude/skills/documentation
Command: npx skills add https://github.com/BfdCampos/dotfiles --skill documentation-bfdcampos

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This guidance ensures every written document is produced as a markdown file rather than outputting to the terminal, helping writers create a persistent, accessible artifact.

Core Features & Use Cases

  • Always write to a file: outputs are saved as a markdown document in a predictable location.
  • Make it readable: use headers, bullets, and formatting to improve scanning and comprehension.
  • Diagrams and tone: support diagrams via mermaid when needed and adapt tone to the document type (technical docs, proposals, brainstorming, plans).

Quick Start

Create a new document named your-topic.md and start drafting with a clear, structured outline.

Frequently Asked Questions about documentation

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

FAQPage Schema
How do I save terminal output directly to a markdown file?

To save terminal output to a markdown file, every writing task must be routed to save results directly as a .md document in a predictable location. This approach eliminates ad-hoc terminal outputs and ensures a persistent, accessible artifact.

What is the best way to structure a markdown document for readability?

The best way to structure a markdown document for readability is to use headers, bullets, and formatting to improve scanning and comprehension. Always draft your topic with a clear, structured outline from idea to README.

Can I include mermaid diagrams in my markdown documentation?

Yes, you can include mermaid diagrams in your markdown documentation when visual support is needed. This ensures complex technical docs, proposals, and plans remain clear and well-structured within the file.

How do I adapt writing tone for different types of markdown documents?

To adapt writing tone for different markdown documents, adjust the style based on the specific document type, such as technical docs, proposals, brainstorming notes, or plans. This maintains consistency and readability across the file.

Does this documentation approach work for brainstorming and proposals?

Yes, this documentation approach works for brainstorming and proposals by covering planning, notes, and guides. It enforces writing-to-file and structured formatting to produce a consistent, readable markdown artifact.