How does the Documentation Testing skill detect missing environment variables?

It scans your codebase for language-specific patterns like process.env or os.getenv and cross-references them with your README and .env.example files to find discrepancies.

What does the Documentation Health Report include?

The report provides a structured summary of passed, failed, and ambiguous steps, along with specific recommendations for fixing missing or broken instructions.

Can this skill help with cross-platform documentation issues?

Yes, it identifies platform-specific gaps such as shell command differences between macOS and Linux (e.g., sed variations) or path separator issues on Windows.

Does it actually run the code to test the documentation?

It uses the 'Read' tool to analyze files and apply logical heuristics to identify likely points of failure, providing a systematic validation sequence for the user to follow.

When should I use the documentation-testing skill?

It is best used when updating your setup process, before onboarding new developers, or when performing a general audit of a project's documentation quality.

Documentation Testing & Audit

Name: Documentation Testing & Audit
Author: jimmc414

byjimmc414

•

학습 및 문서화

Identifies gaps, broken instructions, and missing prerequisites in project documentation to ensure seamless developer onboarding.

This skill provides a systematic framework for auditing README files, setup guides, and onboarding documentation within Claude Code. By applying specialized heuristics, it detects common failures such as undocumented environment variables, missing database migration steps, and platform-specific command issues. It helps maintain high-quality project documentation by generating detailed health reports that highlight exactly where instructions are ambiguous or incorrect, ensuring that new developers can move from cloning a repository to a running application without friction.

주요 기능

01Cross-platform compatibility checks for shell commands and file paths

02Heuristic-based detection of missing prerequisites across multiple languages

03Validation of multi-step setup sequences including database and service dependencies

041 GitHub stars

05Automated identification of undocumented environment variables in source code

06Standardized Documentation Health Reports with Pass/Fail/Ambiguous ratings

사용 사례

01Auditing a repository's README before a major release or public launch

02Ensuring environment variable documentation is in sync with the current codebase

03Validating onboarding instructions for new team members to prevent setup friction

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add jimmc414/claude-code-plugin-marketplace documentation-testing

For use in Claude.ai and ChatGPT

Download Skill