documentation

19
0
Source

Feature documentation and release notes patterns. Use when documenting changes, writing PR descriptions, or preparing releases.

Install

mkdir -p .claude/skills/documentation && curl -L -o skill.zip "https://mcp.directory/api/skills/download/1637" && unzip -o skill.zip -d .claude/skills/documentation && rm skill.zip

Installs to .claude/skills/documentation

About this skill

Documentation

PR Description

## Summary
- What this PR does (bullet points)

## Test Plan
- How to verify it works

## Related Issues
- Resolves #123

Changelog Entry

### [VERSION] - [DATE]

#### New Features
- **Feature Name**: Brief description

#### Improvements
- **Improvement**: What changed and why

#### Bug Fixes
- **Fix**: What was broken (#issue)

#### Breaking Changes
- **Change**: What breaks, migration steps

Feature Documentation

When documenting a feature, cover:

User Impact

  • What capability does this add?
  • How do users access it?

Technical Changes

  • API changes (endpoints, params)
  • SDK changes (new methods)
  • Database migrations
  • Config changes

Breaking Changes (if any)

  • What breaks
  • Migration steps

Key Files

  • CHANGELOG.md - Self-hosted deployment changelog (breaking/critical changes only)
  • apps/opik-documentation/documentation/fern/docs/changelog/ - Main product docs changelog entries (dated .mdx files)
  • apps/opik-documentation/documentation/fern/docs/agent_optimization/getting_started/changelog.mdx - Agent Optimizer release changelog
  • apps/opik-documentation/documentation/fern/docs.yml - Docs routing/navigation source of truth for changelog surfaces
  • .github/release-drafter.yml - Release template

Changelog Routing Rules

  • Pick the changelog target by scope; do not default everything to root CHANGELOG.md.
  • Use CHANGELOG.md only for self-hosted deployment breaking/critical/security-impacting notes.
  • Use apps/opik-documentation/documentation/fern/docs/changelog/*.mdx for general Opik product release notes shown in /docs/opik/changelog.
  • Use apps/opik-documentation/documentation/fern/docs/agent_optimization/getting_started/changelog.mdx for Agent Optimizer version updates (for example sdks/opik_optimizer releases like 3.1.0).
  • Liquibase changelog.xml files are migration manifests, not user-facing release-note changelogs.
  • If unsure where an entry belongs, confirm the surface from apps/opik-documentation/documentation/fern/docs.yml before editing.

Images in documentation

  • Use fern/img for documentation images (e.g. apps/opik-documentation/documentation/fern/img/...).
  • Do not use static/img for new assets; it is a legacy folder used by external integrations and cannot be deleted.
  • Reference images in docs as /img/... (e.g. /img/tracing/openai_integration.png).
  • In repos that define docs.yaml/docs.yml, treat that file as the routing source of truth; do not assume URLs mirror directory layout.

Internationalized READMEs

Non-English README files (readme_CN.md, readme_JP.md, readme_KO.md, readme_PT_BR.md) are AI machine-translated from the English README.md.

  • Each non-English README must have a notice at the top (as a blockquote) warning that the file is AI-translated and welcoming improvements.
  • When the English README is updated with significant content changes, re-translate the affected non-English READMEs using AI and update accordingly.
  • Do not manually edit translated READMEs for content changes; update the English source and re-translate.

Style

  • User perspective, not implementation details
  • Specific (version numbers, dates)
  • Code examples for API/SDK changes
  • Concise - link to docs, don't duplicate

You might also like

flutter-development

aj-geddes

Build beautiful cross-platform mobile apps with Flutter and Dart. Covers widgets, state management with Provider/BLoC, navigation, API integration, and material design.

282789

drawio-diagrams-enhanced

jgtolentino

Create professional draw.io (diagrams.net) diagrams in XML format (.drawio files) with integrated PMP/PMBOK methodologies, extensive visual asset libraries, and industry-standard professional templates. Use this skill when users ask to create flowcharts, swimlane diagrams, cross-functional flowcharts, org charts, network diagrams, UML diagrams, BPMN, project management diagrams (WBS, Gantt, PERT, RACI), risk matrices, stakeholder maps, or any other visual diagram in draw.io format. This skill includes access to custom shape libraries for icons, clipart, and professional symbols.

205415

godot

bfollington

This skill should be used when working on Godot Engine projects. It provides specialized knowledge of Godot's file formats (.gd, .tscn, .tres), architecture patterns (component-based, signal-driven, resource-based), common pitfalls, validation tools, code templates, and CLI workflows. The `godot` command is available for running the game, validating scripts, importing resources, and exporting builds. Use this skill for tasks involving Godot game development, debugging scene/resource files, implementing game systems, or creating new Godot components.

200282

nano-banana-pro

garg-aayush

Generate and edit images using Google's Nano Banana Pro (Gemini 3 Pro Image) API. Use when the user asks to generate, create, edit, modify, change, alter, or update images. Also use when user references an existing image file and asks to modify it in any way (e.g., "modify this image", "change the background", "replace X with Y"). Supports both text-to-image generation and image-to-image editing with configurable resolution (1K default, 2K, or 4K for high resolution). DO NOT read the image file first - use this skill directly with the --input-image parameter.

210231

ui-ux-pro-max

nextlevelbuilder

"UI/UX design intelligence. 50 styles, 21 palettes, 50 font pairings, 20 charts, 8 stacks (React, Next.js, Vue, Svelte, SwiftUI, React Native, Flutter, Tailwind). Actions: plan, build, create, design, implement, review, fix, improve, optimize, enhance, refactor, check UI/UX code. Projects: website, landing page, dashboard, admin panel, e-commerce, SaaS, portfolio, blog, mobile app, .html, .tsx, .vue, .svelte. Elements: button, modal, navbar, sidebar, card, table, form, chart. Styles: glassmorphism, claymorphism, minimalism, brutalism, neumorphism, bento grid, dark mode, responsive, skeuomorphism, flat design. Topics: color palette, accessibility, animation, layout, typography, font pairing, spacing, hover, shadow, gradient."

169197

rust-coding-skill

UtakataKyosui

Guides Claude in writing idiomatic, efficient, well-structured Rust code using proper data modeling, traits, impl organization, macros, and build-speed best practices.

165173

Stay ahead of the MCP ecosystem

Get weekly updates on new skills and servers.