Does it automatically apply changes to my docs?

No, the skill first generates a comprehensive Docs Sync Report with evidence and proposed edits, then asks for user approval before making any changes.

Can it detect missing configuration options?

Yes, it uses targeted searches for patterns like 'os.environ' and configuration classes to ensure all user-facing settings are represented in the documentation.

Does this skill update translated documentation?

No, this skill is configured to only update English documentation and explicitly avoids modifying translated files in directories like docs/ja, docs/ko, or docs/zh.

How does it handle reference documentation?

It treats source code docstrings as the source of truth, updating them directly so that regenerated reference pages stay correct instead of manually editing generated Markdown.

Documentation Sync

Name: Documentation Sync
Author: openai

byopenai

•

18,501

•

Gestión de Contenido

Automates the identification and synchronization of documentation gaps by comparing codebase implementation with existing documentation.

The Documentation Sync skill serves as an intelligent auditor for your project's technical content. It meticulously analyzes source code, configuration settings, and environment variables to detect undocumented features or outdated information. By performing both code-first and doc-first passes, it identifies discrepancies between your implementation and your Markdown files, providing a detailed report with evidence-based suggestions. It is designed to keep technical manuals, API references, and setup guides perfectly aligned with the actual behavior of the codebase while maintaining structural integrity.

Características Principales

01OpenAI Developer Docs integration for platform-specific accuracy

02Structural analysis to improve documentation discoverability

03Automated gap detection between implementation and documentation

04Source-of-truth docstring updates for accurate reference generation

05Detailed reporting with file-specific evidence and insertion points

0618,501 GitHub stars

Casos de Uso

01Syncing technical docs with new configuration options or environment variables

02Auditing documentation coverage before a major production release

03Identifying and fixing outdated names or default values in API guides

Características Principales

01OpenAI Developer Docs integration for platform-specific accuracy

02Structural analysis to improve documentation discoverability

03Automated gap detection between implementation and documentation

04Source-of-truth docstring updates for accurate reference generation

05Detailed reporting with file-specific evidence and insertion points

0618,501 GitHub stars

Casos de Uso

01Syncing technical docs with new configuration options or environment variables

02Auditing documentation coverage before a major production release

03Identifying and fixing outdated names or default values in API guides