Documentation Guidelines

Name: Documentation Guidelines
Author: thienanblog

Checked

thienanblog·vlatest·writing·Apache-2.0

Helps with documentation, guidelines as part of writing, documentation, and content creation workflows.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

Run this in your project

terminal

$ npx skills add thienanblog/awesome-ai-agent-skills --skill documentation-guidelines -a claude-code

Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

thienanblog

Taken from the source listing. We haven't verified who controls this account.

Install target

Live repository

Not pinned. Installing fetches whatever the repository holds at the time you run the command.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned 27 Sept 2026

This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.

Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned thienanblog/awesome-ai-agent-skills at 3e98ac3c2c.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit: 3e98ac3c2c
Manifest: skills/documentation-guidelines/SKILL.md
Scanned: 8 files, 980 lines
Copies in repo: 2 — all of them scanned

This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.

What each check looks for →

About this skill

What it does

This skill helps AI agents generate documentation that adheres to established guidelines. It ensures consistency and clarity in technical writing, formatting code snippets correctly, and maintaining a professional tone. The agent can adapt its output based on specified style guides or create new ones from examples.

When to use it

Generating API documentation for a software project.
Creating user manuals for complex applications.
Producing internal knowledge base articles with consistent formatting.
Transforming existing text into a specific documentation format (e.g., Markdown, reStructuredText).

Key capabilities

Adherence to specified style guides.
Code snippet formatting and highlighting.
Consistent tone and voice generation.
Creation of new style guides from examples.

Example prompts

"Write documentation for the 'calculate_average' function, following Google Developer Documentation Style Guide."
"Generate a user manual section explaining how to configure network settings in Markdown format."
“Create a documentation style guide based on these example documents.”

Tips & gotchas

The quality of the generated documentation depends heavily on the clarity and specificity of the provided guidelines or examples. Providing incomplete or ambiguous instructions may result in inaccurate or inconsistent output.