Common Documentation logo

Common Documentation

Community
HoangNguyen0403
common-documentation

Write effective code comments, READMEs, and technical documentation following intent-first principles. Use when adding comments, writing docstrings, creating READMEs, or updating any documentation.

Overview

PublisherHoangNguyen0403
Repositoryagent-skills-standard
Skill namecommon-documentation
Stars
569
Forks
164
Bundled files
2
LicenseMIT
Links
Skill sourceRepositoryHomepage
  • Markdown instructions

    A SKILL.md file the model loads on demand, so it only costs tokens when a request actually matches.

  • Works with any LLM

    AI skills are plain Markdown, not provider-specific code, so this works with GPT, Claude, Gemini, Grok, or a local model.

  • 2 bundled files

    Scripts, templates, and references the model can read while it works. Files are read-only and never executed.

  • Open source

    Published by HoangNguyen0403 on GitHub. Read the source before you install it.

Installation

Install the Common Documentation AI skill in TypingMind to use it with any LLM, or drop it into another agent that reads SKILL.md.

1

Install in TypingMind

TypingMind installs a skill straight from its GitHub folder — it reads SKILL.md, bundles the resource files, and stores the result locally.

  1. Open the app and go to Plugins → Skills.
  2. Choose "Install from GitHub".
  3. Paste the skill folder URL below and confirm.
  4. Enable the skill in any chat where you want it available.
Plugins → Skills → Add skill → From GitHub URL, then paste the folder URL and press Continue.
2

Install in another agent

Any agent that reads the Agent Skills format can use this skill — copy the folder into that agent's skills directory.

Claude Code — .claude/skills
git clone --depth 1 https://github.com/HoangNguyen0403/agent-skills-standard.git /tmp/agent-skills-standard
mkdir -p .claude/skills
cp -r /tmp/agent-skills-standard/skills/common/common-documentation .claude/skills/common-documentation
Restart Claude Code after copying so it picks up the new skill.

Use it in TypingMind

Enable Common Documentation in any TypingMind chat and the model takes it from there. Its name and description sit in the system prompt, and the moment a request matches, the model loads the full instructions itself — you never invoke it by hand, and it costs no tokens until it is actually used.

The model loads Common Documentation on its own as soon as a request matches it.

Works with any AI model

AI skills are plain Markdown instructions rather than provider-specific code, so Common Documentation is not tied to the model it was written for. Install it once in TypingMind and use it with GPT-5, Claude, Gemini, Grok, DeepSeek, Mistral, Llama, or a local model you run yourself — all on your own API keys.

  • Loaded only when it is needed

    The system prompt carries just the name and description. The instructions are fetched on the first matching request, so an idle skill costs nothing.

  • Switch models mid-chat

    Because the skill is instructions rather than code, changing model does not break it — the next model reads the same SKILL.md.

Skill instructions

This is the SKILL.md content the model loads. Read it before installing — a skill is instructions your model will follow.

Documentation Standards

Priority: P2 (MEDIUM)

1. Intent-First Comments

  • Explain "Why" logic exists. Avoid "What" mechanics.
  • Use triple-slash (Dart/Swift) or JSDoc (TS/JS) for public members.
  • Delete commented-out code. Use Git history.
  • Format: TODO(username): description. Link tickets.
  • For retry backoff, explain that jitter prevents the thundering herd; document intent rather than restating the delay calculation.

2. README Structure

  • Mission: Project purpose (one sentence).
  • Onboarding: Prerequisites, installation, usage (exact).
  • Maintenance: Document inputs/outputs, known quirks, fixes.
  • Sync: Documentation ships with feature.

3. ADRs & Architecture

  • ADRs: Document rationale for system changes in docs/adr/.
  • Docstrings: Include Args, Returns, and Usage examples (>>>).
  • Diagrams: Use Mermaid.js inside Markdown.

4. API Docs

  • Use Swagger/OpenAPI for REST.
  • Provide copy-pasteable examples for endpoints.
  • Define contract before implementation.

Anti-Patterns

  • No "what" comments: Explain intent. Refactor mechanics.
  • No orphan TODOs: Require owner and ticket.
  • No stale docs: Document during development.

Canonical response anchors

When this skill applies, preserve the following domain terminology or equivalent concrete examples in the answer when relevant:

  • JSDoc
  • Usage
  • why

Bundled files

The model reads these on demand while the skill is loaded. They are exposed as readable files and are never executed.

Frequently asked questions

What does the Common Documentation AI skill do?

Write effective code comments, READMEs, and technical documentation following intent-first principles. Use when adding comments, writing docstrings, creating READMEs, or updating any documentation.

Why use Common Documentation on TypingMind?

Because you install it once and use it with any model. Common Documentation is plain Markdown rather than provider-specific code, so the same skill runs on GPT-5, Claude, Gemini, Grok, or a local model — and you can switch model mid-chat without it breaking. TypingMind runs on your own API keys, so you pay providers directly instead of a per-seat subscription, and your skills and chats stay in your own storage.

How do I install Common Documentation in TypingMind?

Open Plugins → Skills → Install from GitHub in TypingMind and paste https://github.com/HoangNguyen0403/agent-skills-standard/tree/develop/skills/common/common-documentation. TypingMind reads its SKILL.md and bundles its files and installs it as a skill you can enable per chat.

Which AI models can use Common Documentation?

Any model you connect in TypingMind. AI skills are plain Markdown instructions rather than provider-specific code, so GPT, Claude, Gemini, Grok, and local models can all load this skill when a request matches it.

How many AI models can I use with Common Documentation?

As many as you like. As long as a model supports skills, you can use Common Documentation with it — GPT, Claude, Gemini, Grok, DeepSeek, Mistral, Llama and more — all on TypingMind with your own API keys.

Is the Common Documentation AI skill free?

Yes. It is published on GitHub by HoangNguyen0403 under the MIT license. You only pay your own AI provider for the tokens you use.

What are AI skills?

An AI skill is a reusable instruction bundle that teaches an AI model how to do one specific task. It follows the open Agent Skills format: a SKILL.md file with a name and description, plus any scripts, templates or reference files the model may need. The model reads the instructions only when your request matches the skill, so an installed skill costs nothing until it is used.

How are AI skills different from plugins or MCP servers?

A plugin or MCP server gives a model new tools to call — code that runs somewhere and returns a result. An AI skill gives the model knowledge and process instead: how to approach a task, which steps to follow, what good output looks like. Skills are plain Markdown, so they need no server, no API key and no runtime, and they work with any model.

Related AI Skills

View all
obra logo

Test Driven Development

obra
CommunityPopular

Use when implementing any feature or bugfix, before writing implementation code

25.8K
288.1K
1 files
View
obra logo

Using Git Worktrees

obra
CommunityPopular

Use when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallback

25.8K
288.1K
Instructions
View
obra logo

Using Superpowers

obra
CommunityPopular

Use when starting any conversation - establishes how to find and use skills, requiring skill invocation before ANY response including clarifying questions

25.8K
288.1K
5 files
View
obra logo

Verification Before Completion

obra
CommunityPopular

Use when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence…

25.8K
288.1K
Instructions
View

Set up your own AI workspace now

Get notified about new features and future giveaways by subscribing to our newsletter 👇