Skip to main content

technical-writing

Guide for writing effective technical documentation, specs, and markdown files. Use when creating or editing specs, documentation, READMEs, AGENTS.md files, or any markdown content in the codebase.

Informations de source

Dépôt
cashew-labs/libretto
Dernière activité de la source
4 mars 2026 à 23:18
Langue détectée de SKILL.md
anglais
Étoiles
902
Forks
70

Options d'installation

Le prompt qui vérifie d'abord la source est sélectionné par défaut. Vous pouvez passer à une commande directe ou télécharger une copie locale.

Vérifiez les fichiers source

Lisez SKILL.md et les fichiers associés affichés par SkillsMP avant de décider de l'installer.

Affichage de SKILL.md

SKILL.md
Instructions source · Aperçu en lecture seule
name
technical-writing
description
Guide for writing effective technical documentation, specs, and markdown files. Use when creating or editing specs, documentation, READMEs, AGENTS.md files, or any markdown content in the codebase.
# Technical Writing ## Audience Assume readers are at least as smart as you, so do not over-explain. State information once and move on. ## Style Write concise, complete sentences using active voice and present tense. Each paragraph or bullet should express a single idea. ## Formatting - Do not use emojis. - Do not use bold or italics. - Use headings, lists, and code blocks only when they add clarity. - Use fenced code blocks with language identifiers. ## Paths Always use relative file paths: `docs/testing.md`, not `/Users/name/project/docs/testing.md`. ## Do Not Repeat Link to existing resources instead of duplicating content. Reference other docs, web pages, or files rather than restating their information.
Voir sur GitHub