Documentation skills bfdcampos documentation
Skill bg-szy/TOP-SKILLS/skills/marketplace/documentation__skills-bfdcampos-documentation
Use this skill whenever writing any document - plans, proposals, docs, documentation, brainstorm docs, notes, guides, specs, designs, READMEs, or any markdown file output.From its SKILL.md
npx -y skills add bg-szy/TOP-SKILLS --skill documentation__skills-bfdcampos-documentationAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
2 things to look at
- no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
- 4 stars4 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.
SKILL.md
1.3 KB, 246 tokens by cl100k_base, as published. Nobody here has run it
Documentation Skill
When creating any written document, follow these principles.
Always Write to a File
Never dump long-form content to the terminal. Always write to a .md file and tell the user where it is.
Use sensible naming - the topic and optionally a timestamp if uniqueness matters.
Make It Readable
- Use headers to create structure
- Break up walls of text with bullets, lists, or tables
- Use code blocks for commands and configs
- Keep paragraphs short
- Use formatting (bold, code, etc.) to aid scanning
Diagrams
When architecture, flows, or relationships would benefit from visualisation, use the mermaid skill.
Tone
Match the document's purpose:
- Technical docs → clear and direct
- Proposals → persuasive but honest
- Brainstorms → exploratory, capture ideas freely
- Plans → actionable, concrete steps
Emojis
Use emojis for visual navigation (section headers, callouts) when they help. Don't overdo it. Skip them entirely if the document is formal or technical.
That's It
Don't overthink it. Write clearly, structure logically, output to a file.
What ships with it: 1 file
10.6 KB alongside SKILL.md
- skill-report.json10.6 KB