Document Readme Checklist Form
Use this form to ensure your document README is complete, clear, and ready for your intended audience.
Document Title
*
Document Type
*
Please Select
Technical Specification
User Guide
API Reference
Project Overview
Release Notes
Other
Current Version
*
Author/Owner Name
*
Last Updated Date
*
 -
Month
 -
Day
Year
2 digit month, 2 digit day, 4 digit year
Date
Intended Audience
*
Please Select
Developers
End Users
Project Managers
QA/Testers
Other
Required README Content Checklist (select all that apply)
*
Project Overview/Description
Installation Instructions
Usage Examples
Configuration Details
Contributing Guidelines
License Information
Contact/Support Info
Other
Formatting and Readability Review
*
Clear and well-structured
Needs minor improvements
Needs major improvements
Links and Resources Verification
*
All links/resources work and are up to date
Some links/resources need updates
Links/resources missing or broken
Final Completion Status
*
README is complete and ready
README requires further work
Submit Checklist
Should be Empty: