Batch Documentation Operations

关于

Acts as a high-level director for managing large sets of documentation. This skill efficiently handles batch operations like writing, validating, and auditing across numerous files identified by wildcard patterns. It orchestrates tasks by delegating to a single-document manager, executing them in parallel for speed while using file locking to prevent conflicts. Safety is paramount, with built-in previews and user confirmation for destructive actions, comprehensive progress reporting, and graceful handling of partial failures.

主要功能

• Performs batch operations (write, validate, audit) on documents matching wildcard patterns.
• 1 GitHub stars
• Aggregates results and gracefully handles partial failures, providing a clear summary of successes and errors.
• Generates detailed audit reports on documentation status, types, and validation issues.
• Executes operations in parallel with concurrency limits and file locking for speed and safety.
• Provides previews and requires user confirmation before executing destructive operations.

使用场景

• Applying a content or metadata update across hundreds of API documentation files at once.
• Running a validation check on all documentation files in a repository to ensure they meet standards.
• Generating a comprehensive audit report of an entire documentation suite to identify issues like missing files or incorrect metadata.