Home

Principles Diagram

Semantic Docstrings add a semantic layer to Python documentation:

  • Reveal why code exists (not just what it does).
  • Make responsibility, context, role, and boundaries explicit.
  • Improve developer onboarding, code review, refactoring safety.
  • Enhance LLM/code assistant reasoning with higher information density.

Quick Start

One-Line Installation (Claude Code Plugin)

bash -c "$(curl -fsSL https://raw.githubusercontent.com/daviguides/semantic-docstrings/main/install.sh)"

Read the Docs

Quick Start (Claude Code)

Add this to ~/.claude/CLAUDE.md:

# Project Documentation Standards

## Standards Inheritance
- **INHERITS FROM**: @./semantic-docstrings/docs/semantic_docstrings.md
- **PRECEDENCE**: Project-specific rules override repository defaults
- **FALLBACK**: When no override exists, semantic-docstrings applies