Can it help with non-English documentation?

Yes, it specifically provides bilingual support, generating insights and explanations in both English and Chinese for every annotation.

Which documentation frameworks does this skill support?

It primarily supports Diataxis, the Google Developer Documentation Style Guide, the Microsoft Writing Style Guide, and Write the Docs standards.

How do I trigger specific annotations?

You can use built-in commands like /annotate-concept or /create-exercise, or simply mention documentation files located in your DocFramework directory.

Is the output compatible with Markdown editors like Obsidian?

Yes, the skill uses standard Markdown and Obsidian-style callouts (e.g., [!success], [!info]) to ensure your notes look great in Obsidian and other compatible editors.

Documentation Framework Annotator

Name: Documentation Framework Annotator
Author: duanbiao2000

byduanbiao2000

•

学习与文档

Annotates technical documentation frameworks and style guides with bilingual insights, heuristic questions, and practical examples.

The Documentation Framework Annotator is a specialized Claude Code skill designed to help technical writers and developers master complex documentation standards like Diataxis, the Google Developer Documentation Style Guide, and the Microsoft Writing Style Guide. It transforms raw framework text into interactive learning materials by adding bilingual (English/Chinese) callouts, comparative 'good vs. bad' examples, and thought-provoking heuristic questions. Whether you are auditing existing docs or learning best practices, this skill provides the structure needed to implement world-class documentation patterns effectively within your knowledge base.

主要功能

01Bilingual English-Chinese annotation support for global accessibility.

02Framework-specific patterns for Diataxis, Google, and Microsoft standards.

03Comparative analysis through 'Good vs. Bad' code and writing examples.

041 GitHub stars

05Seamless integration with Obsidian callout syntax for rich visual formatting.

06Automated heuristic question generation to stimulate deep learning and retention.

使用场景

01Converting technical style guides into interactive internal team training materials.

02Generating self-check exercises and practice points for technical writing mastery.

03Auditing project documentation against the Diataxis four-dimension framework.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add duanbiao2000/obsidiandoc26 doc-framework-annotator

For use in Claude.ai and ChatGPT

Download Skill