Documentation & Developer Onboarding Audit Workflow Prompt

Overview: Audit the documentation and developer onboarding experience of a repository for a new engineer.

SOP Instructions

56 - DOCUMENTATION & DEVELOPER ONBOARDING AUDIT

Audit the documentation and developer onboarding experience of this
repository. Assume you are a new engineer joining the team.

Review:

1) README quality
   - Is the project purpose clear?
   - Are prerequisites listed?
   - Are setup steps correct and complete?
   - Is there a quick-start example?

2) Local development setup
   - Dependencies and versions
   - Environment variables
   - Database and service setup
   - Commands to install, run, test, and build

3) Architecture documentation
   - High-level system diagrams or descriptions
   - Module or folder explanations
   - Data flow and API descriptions

4) API documentation
   - Endpoint list
   - Request/response examples
   - Authentication details
   - Error handling

5) Code documentation
   - Inline comments where needed
   - Docstrings or JSDoc
   - ADRs or decision records

6) Testing documentation
   - How to run tests
   - How to write new tests
   - Test data and fixtures

7) Deployment and operations docs
   - Release process
   - Rollback process
   - Environment differences
   - Incident runbooks

8) Contribution guide
   - Branching and PR workflow
   - Coding standards
   - Commit conventions
   - Review process

9) Troubleshooting
   - Common errors and solutions
   - Where to find logs
   - How to report issues

For each gap, provide:

- the missing or inaccurate documentation,
- why it hurts onboarding,
- a concrete recommendation.

End with:

- a documentation health score,
- the five most urgent doc improvements,
- a suggested docs structure if current one is weak.

Do not write the docs. Provide the audit as a report only.