Tech Writer/Editor's Checklist

Developed by Sneha Pandey

About This Framework

This comprehensive audit checklist standardizes documentation quality across engineering and content teams. It ensures every document is accurate, accessible, and ready for production.

Manual Review: Use this checklist as a step-by-step guide during peer reviews or self-edits. It helps you verify technical details, such as API placeholders, and confirms that content meets global accessibility standards.

AI Integration: To automate your workflow, export the checklist as a JSON configuration. You can then use this file as a system prompt for your Large Language Model (LLM). This structured rubric helps AI agents audit Markdown files for style and AI-readiness.

How to use the JSON Rubric with AI

  1. Click Export JSON Rubric to download the structured configuration file.
  2. Open the JSON file and copy its entire content.
  3. In your AI tool (ChatGPT, Claude, Gemini), use the following prompt: "Act as a Senior Technical Editor. Use the following JSON rubric to audit my technical documentation. Provide a detailed report on gaps and suggest specific rewrites based on the checkpoints provided: [PASTE JSON CONTENT HERE]"
  4. Upload your Markdown or text file to the AI to receive an automated, rubric-aligned audit.