What principles does this skill follow?

It is primarily based on Google's technical writing principles, focusing on clarity, brevity, active voice, and writing for specific audience expertise levels.

Can it help with non-English documentation?

Yes, it includes specific considerations for Spanish technical writing, including guidance on when to translate terms versus keeping them in English.

How does it improve code documentation?

It provides standardized patterns for function docstrings (args, returns, raises) and ensures inline comments focus on the 'why' rather than just the 'what'.

Does it provide a structure for tutorials?

Yes, it includes a standardized format covering learning outcomes, prerequisites, environment setup, step-by-step instructions, and complete examples.

Technical Documentation & Writing

Name: Technical Documentation & Writing
Author: chekos

bychekos

学習とドキュメンテーション

Applies industry-standard Google technical writing principles to create clear documentation, tutorials, and structured code comments.

概要

This skill equips Claude with the formal methodology used by top-tier engineering teams to produce accessible and effective technical content. It focuses on clarity, structural hierarchy for readability, and audience-appropriate communication, ensuring that everything from inline code comments to comprehensive tutorials follows best practices like the active voice, progressive disclosure, and consistent terminology. Whether you are drafting a README, explaining a complex architectural pattern, or writing bilingual technical guides, this skill ensures your communication is professional, concise, and easy to scan.

主な機能

Structured tutorial and step-by-step guide generation
Bilingual (English/Spanish) technical content optimization
Complex concept simplification using the analogy approach
Google Technical Writing Principles implementation
Standardized code documentation and function docstrings
0 GitHub stars

ユースケース

Generating comprehensive README files and API documentation for repositories
Improving code maintainability through standardized inline and function-level comments
Drafting developer tutorials with clear learning outcomes and prerequisites

概要

主な機能

Structured tutorial and step-by-step guide generation
Bilingual (English/Spanish) technical content optimization
Complex concept simplification using the analogy approach
Google Technical Writing Principles implementation
Standardized code documentation and function docstrings
0 GitHub stars

ユースケース

Generating comprehensive README files and API documentation for repositories
Improving code maintainability through standardized inline and function-level comments
Drafting developer tutorials with clear learning outcomes and prerequisites