Skip to content

TsukiNi22/ai-utils / skills/docs/readme-style

readme-style

Flagged

Tsukini's style for README.md and Markdown documentation (from libutils, context-forge, c2dmp-hsm, s.o.s) - title + tagline, Table of Contents, Dependencies/Packages/Quick Setup/Usage/Workflows sections, GitHub callouts, tables, bash blocks. Use whenever writing, rewriting or reviewing a README or any Markdown doc for one of the user's projects. For a GitHub wiki use wiki-style; for CHANGELOG/release notes use git-conventions; for HTML docs use html-doc.

FileKindSize
SKILL.mdskill md4.8 KB
templates/README-lib.mdmarkdown736 B
templates/README.mdmarkdown3.4 KB
---
name: readme-style
description: Tsukini's style for README.md and Markdown documentation (from libutils, context-forge, c2dmp-hsm, s.o.s) - title + tagline, Table of Contents, Dependencies/Packages/Quick Setup/Usage/Workflows sections, GitHub callouts, tables, bash blocks. Use whenever writing, rewriting or reviewing a README or any Markdown doc for one of the user's projects. For a GitHub wiki use wiki-style; for CHANGELOG/release notes use git-conventions; for HTML docs use html-doc.
metadata:
  summary: 'README / Markdown docs structure: Table of Contents, Dependencies, Packages, Quick Setup, Usage, GitHub callouts, tables.'
---

# Tsukini README / Markdown doc style

English (unless the user asks for another language), direct, technical, no emoji, no marketing.
**Location**: `README.md` at the root of the repository (`git rev-parse --show-toplevel`), or in the current folder
outside a repository; never in `docs/` unless the user asks for it. Templates: `templates/README.md` (application or
full library) and `templates/README-lib.md` (small header-only/algorithm library).
CHANGELOG and release descriptions: the `git-conventions` skill. HTML documentation: the `html-doc` skill.

## Structure (full project: libutils, context-forge)
```markdown
# <project-name>

> [!TIP]
> Documentation [<owner>/<repo>](<doc url>) (vX.Y.Z).          <- only if an HTML/wiki doc exists

<1-3 lines: what it is, how it works, the fallback/limits>

### Table of Contents
 - [Dependencies](#dependencies)
 - [Packages](#packages)
 - [Quick Setup 1 (All)](#quick-setup---1-all)
 - [Quick Setup 2 (Limited)](#quick-setup---2-limited)
 - [Usage](#usage)
 - [Unit tests](#unit-tests)
 - [Workflows/Release](#workflowsrelease)

## Dependencies
## Packages
## Quick Setup - 1 (all)
## Quick Setup - 2 (Limited)
## Usage
## Unit tests
## Workflows/Release
```
- `# title` = repository name as is (`context-forge`, `c2dmp-hsm`, or the display name `Utils`, `S.O.S`).
- Small library (c2dmp-hsm, s.o.s): `# name`, then the acronym tagline in a quote with the bold letters
  (`> **S**teganography **O**ptimized and **S**ecurized`), then `## Installation` with `####` steps
  (`#### Cloning the repository`, `#### Build & Installation`, `#### Include`).
- Table of Contents: `### Table of Contents`, items ` - [Name](#anchor)` (one leading space).
- Only the sections that make sense for the project, always in this order.

## Sections content
- **Dependencies**: `> [!CAUTION]` license disclaimer, then a table
  `| Name + Link | Status | Last Update |` with the workflow badge and
  `![](https://img.shields.io/github/last-commit/<owner>/<repo>)`.
  Build requirements: `| Name | Version | Fedora (\`dnf\`) | Debian/Ubuntu (\`apt\`) |`.
- **Packages**: `> [!NOTE]` about the `-pre` packages, then `| File Name | Content |`.
- **Quick Setup - 1 (all)**: subtitle quote `> Setup into \`/usr/local\``, `### Clone the repository`,
  `### Build & install` (or `### Install the lib`) with bash blocks:
  ```bash
  export BUILD_DIR=build
  cmake -S . -B $BUILD_DIR
  sudo cmake --build $BUILD_DIR --target install --parallel $(nproc)
  ```
- **Quick Setup - 2 (Limited)**: `> Setup into \`/usr\``, the warnings (`invalid hash`, restriction
  `fedora-based (rpm)`, `debian-based (deb)`), the `--no-sudo` note, a numbered list of what the script does,
  the `wget -qO- ... | bash -s` command then `or with \`curl\`:` and the curl one, arguments table
  `| Argument | Effect |`.
- **Usage**: one bash block with commented commands aligned (`cmd   # comment`), then a table of modes/flags.
- **Include** (libraries): `> [!WARNING]` `Everything is defined within the namespace \`x::\``, table
  `| Include | Content |` with the header path and the main signatures in backticks.
- **Workflows/Release**: `### Workflows` (one bullet per workflow, name in backticks + what it does),
  `### Pre-Release (unstable)`, `### Release (stable)` (tag regex, `[build]`/`[release]` keywords).

## Formatting rules
- GitHub callouts everywhere a remark is needed, one idea per callout:
  `> [!NOTE]` info, `> [!TIP]` shortcut/doc link, `> [!IMPORTANT]` required action,
  `> [!WARNING]` restriction/known issue, `> [!CAUTION]` license/danger.
  Multi-paragraph callout: empty `> ` line between paragraphs.
- Tables for every list of items with attributes (packages, flags, includes, paths); header separator
  `| ---- |` sized like the header; code values in backticks.
- Code blocks always with a language (`bash`, `cpp`, `cmake`); comments inside the block rather than prose.
- Inline code for every path, command, flag, type, package, namespace, version.
- `**bold**` only for the key concept of a sentence; no italics.
- Links: relative for repo files, full URLs for other repos; anchors `#quick-setup---1-all` style.
- Sentences short, present tense, `ex:` for examples, `->` for consequences.
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall