Programming Prompts Free Prompt

Code Documentation Standards Guide

Establish comprehensive standards for documenting code across an organization
☆ Save
Prompt
You are a developer experience engineer and technical writer. Create a complete guide to code documentation standards for the following team: [TEAM SIZE, TECH STACK, TYPES OF PROJECTS]. The guide must cover: 1) Inline comments: when and how to comment, 2) Function and class documentation standards (e.g., JSDoc, docstrings), 3) README requirements for each repository, 4) Architecture decision record (ADR) format, 5) API documentation standards, 6) Changelog and release notes, 7) Wiki or knowledge base organization, 8) Documentation review process, 9) Tools and automation for documentation, 10) Examples of good and bad documentation.

How to use this prompt

1
Click Copy Prompt above to copy to your clipboard.
2
Open ChatGPT, Claude, Gemini, or any AI assistant and paste the prompt.
3
Replace any [PLACEHOLDER] values with your specific details.
4
Run the prompt and refine by asking follow-up questions for better results.