Technical Writing
5624 skills in Documentation > Technical Writing
documentation
Use when creating or updating technical documentation, API documentation, or inline code documentation.
command-documentation-patterns
コマンドのドキュメント設計(セルフドキュメンティング構造/使用例/トラブルシューティング)を整理し、説明の一貫性と読みやすさを支援するスキル。章構成、記述ルール、検証手順を一貫して整理する。Anchors:• Software Requirements (Karl Wiegers) / 適用: 要求の言語化と構造化 / 目的: 説明品質の安定化Trigger:Use when documenting commands, creating usage examples, or designing troubleshooting sections for command workflows.command documentation, usage examples, troubleshooting, self-documenting structure
doc-writer
Provides expert guidance for writing compact, effective technical documentation. Use this skill when: (1) user mentions "documentation", "docs", "document", "readme", "architecture", or "API docs", (2) user requests to write, create, update, improve, or review any documentation, (3) user is documenting code, systems, features, or APIs, (4) user is creating README.md, ARCHITECTURE.md, CONTRIBUTING.md, or tutorial files, (5) user requests examples or how-to guides.
task-list-md
Parse and manage tasks list in a markdown file using checklist format (tasks.md, checklist.md)
managing-entries
Create and manage changelog entries. Use when adding changelog entries, finishing features or bugfixes, documenting changes, writing release notes, working in changelog/ directories, wrapping up commits and PRs, or cutting a release.
docusaurus-plugins
Use when creating Docusaurus plugins (remark, rehype, theme, content, lifecycle) to extend markdown, modify HTML, or add custom functionality
user-centric-writing
ユーザー中心のドキュメント・文章作成を専門とするスキル。読者のニーズと理解度に合わせた明確で効果的なコンテンツを作成する。Anchors:• Badass: Making Users Awesome (Kathy Sierra) / 適用: ユーザー成功の視点 / 目的: 読者を成功させる文章設計• Plain Language Guidelines / 適用: 明確で簡潔な文章 / 目的: 理解しやすいコンテンツTrigger:Use when creating user documentation, writing help content, drafting user guides,improving content readability, designing persona-based content, or reviewing text for clarity.
assisting-with-soc2-audit-preparation
This skill assists with SOC2 audit preparation by automating tasks related to evidence gathering and documentation. It leverages the soc2-audit-helper plugin to generate reports, identify potential compliance gaps, and suggest remediation steps. Use this skill when the user requests help with "SOC2 audit", "compliance check", "security controls", "audit preparation", or "evidence gathering" related to SOC2. It streamlines the initial stages of SOC2 compliance, focusing on automated data collection and preliminary analysis.
generating-conventional-commits
Generates conventional commit messages using AI. It analyzes code changes and suggests a commit message adhering to the conventional commits specification. Use this skill when you need help writing clear, standardized commit messages, especially after making code changes and preparing to commit. Trigger with terms like "create commit", "generate commit message", or "write commit".
rust-developer
Comprehensive Rust development guidelines based on 6 months of code reviews. Use when writing Rust code, debugging Rust issues, or reviewing Rust PRs. Covers error handling, file I/O safety, type safety patterns, performance optimization, common footguns, and fundamental best practices. Perfect for both new and experienced Rust developers working on CLI tools, hooks, or production code.
writing-programs
Write TQL programs with documentation guidance. Use when writing TQL code, looking up operators or functions, asking about syntax, or building data pipelines.
bruno-api
Generate comprehensive API endpoint documentation from Bruno (.bru) files by mapping requests to a Django4Lyfe/Diversio-style backend implementation (Django REST Framework or Django Ninja), including auth/permissions, multi-tenant filtering, request/response schemas, and line-numbered code references. Use for single endpoints, directory scans of .bru files, or when writing docs to a specific output path.
prompt-writer
Best practices for writing effective AI prompts from scratch. Applied when creating new prompts, instructions, or system messages for LLMs. Focuses on clarity, specificity, and token efficiency.
poocommerce-copy-guidelines
Guidelines for UI text and copy in PooCommerce. Use when writing user-facing text, labels, buttons, or messages.
storybook-development
Create component documentation and testing with Storybook using CSF3, interaction testing, and visual regression. Use when documenting components, creating UI catalog, or visual testing.
r-data-science
R programming for data analysis, visualization, and statistical workflows. Use when working with R scripts (.R), Quarto documents (.qmd), RMarkdown (.Rmd), or R projects. Covers tidyverse workflows, ggplot2 visualizations, statistical analysis, epidemiological methods, and reproducible research practices.
pytest-testing
Write pytest tests for Python code including unit tests, integration tests, fixtures, mocking, and parametrize. Use when writing tests for functions, classes, or complex business logic.
research-docs
Research and persist coding documentation using Perplexity AI. Use when user asks about documentation, APIs, frameworks, libraries, best practices, coding patterns, or needs to research technical topics. Always checks existing research first.
zod-validation
Zodライブラリによるランタイムバリデーション、スキーマ定義、TypeScript型推論を専門とするスキル。型安全なバリデーションロジックを設計・実装し、API・フォーム・ドメイン層での検証を網羅する。Anchors:• Zod Official Documentation / 適用: スキーマAPI・バリデーション / 目的: 公式パターン準拠• Effective TypeScript (Dan Vanderkam) / 適用: 型設計・型推論 / 目的: ランタイム安全性担保• @hookform/resolvers / 適用: フォーム統合 / 目的: React Hook Form連携Trigger:Use when implementing runtime validation with Zod, defining TypeScript schemas, integrating form validation (react-hook-form), or validating API requests/responses. Keywords: zod, schema, safeParse, refine, z.infer, zodResolver.
codebase-summarizer
Scans repository structure and generates comprehensive architecture documentation including system overview, entry points, module relationships, data flow diagrams, and "edit here for X" guides. Creates ARCHITECTURE.md for onboarding and navigation. Use when users request "document the codebase", "explain the architecture", "create onboarding docs", or "map the system".