skills.rest
Jonathan0823
Jonathan0823COMMUNITY
Explore all skills by this author →
𝕏@GuinnJo1GitHub

code-documentation

Standardize code documentation across Go, Python, TypeScript, and Rust projects.

7|Updated Feb 5, 2026
Search Tags:#documentation#docstrings#best-practices#code-comments#architecture-docs#READMEs
One-click install
npx skills add https://github.com/Jonathan0823/opencode-config --skill code-documentation-jonathan0823
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-documentation
Source: https://github.com/Jonathan0823/opencode-config/tree/main/skills/code-documentation
Command: npx skills add https://github.com/Jonathan0823/opencode-config --skill code-documentation-jonathan0823

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers often grapple with inconsistent code documentation across projects, creating onboarding friction and maintenance challenges. This skill provides structured guidelines, templates, and best practices to unify inline comments, docstrings, and README content.

Core Features & Use Cases

  • Frontmatter-driven metadata: Ensures every document includes a name and description header for consistent discovery and indexing.
  • Multi-language documentation patterns: Guides for Go, Python, TypeScript, and Rust docstrings, function/method docs, and architecture docs.
  • Template-driven artifacts: Ready-to-use README templates, API docs sections, and architecture decision patterns to accelerate documentation and onboarding.

Quick Start

Use this skill to establish a unified documentation standard across a codebase by adding a SKILL.md with a name and description and applying the prescribed layouts to comments, docstrings, and READMEs.

Frequently Asked Questions about code-documentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I standardize code documentation across multiple programming languages?▼

Standardize code documentation by applying structured guidelines and ready-to-use templates for inline comments, docstrings, and READMEs across Go, Python, TypeScript, and Rust projects.

What is the best way to structure a README for developer onboarding?▼

The best way to structure a README is using a template-driven artifact with frontmatter metadata including name and description, followed by standardized Markdown sections to accelerate onboarding and indexing.

Does this documentation standard work with both Python and Go projects?▼

Yes, this documentation standard works with Python and Go projects, providing multi-language documentation patterns for docstrings, function method docs, and architecture guides across both languages.

How do I write architecture decision records for my codebase?▼

Write architecture decision records by applying the provided architecture decision patterns and structured Markdown-based sections, ensuring every document includes frontmatter with a name and description header.

What frontmatter is required for code documentation templates?▼

Required frontmatter for code documentation templates includes a name and description header, which ensures consistent document discovery and indexing across the standardized artifacts.

Related Skills

Explore More Software Engineering Skills→
lobehublobehub
81.4k

microcopy

Guide UI writers to produce consistent bilingual microcopy in English and Chinese.

Official
Basic
lailtonjuniorlailtonjunior

Documentation

Generate and update Markdown and HTML documentation from code, schemas, and design notes.

Community
Intermediate
arbazkhan971arbazkhan971
26

lint

Configure linters, formatters, pre-commit hooks, and CI enforcement across repositories.

Community
Advanced
zero-rehqzero-rehq

api-documentation-generator

Generate OpenAPI specs from TypeScript Express, Next.js, and Fastify source code.

Community
Intermediate