BMAD-METHOD/expansion-packs/bmad-technical-writing/checklists/final-manuscript-checklist.md

4.9 KiB

Final Manuscript Checklist

Use this comprehensive checklist before submitting manuscript to publisher or publishing platform. This meta-checklist coordinates all other quality checklists.

Content Completeness

  • All planned chapters completed
  • Front matter complete (preface, acknowledgments, about author)
  • Back matter complete (appendix, glossary, index, bibliography)
  • All chapter exercises included
  • All exercise solutions provided (in appendix or separately)
  • All figures and diagrams finalized
  • All code examples included and tested

Code Quality

  • All code examples pass code-quality-checklist.md
  • All code examples pass code-testing-checklist.md
  • All code examples pass version-compatibility-checklist.md
  • Code repository finalized and accessible
  • Code repository passes repository-quality-checklist.md
  • README.md in repository is comprehensive
  • All code tested on target platforms (cross-platform-checklist.md if applicable)

Technical Review

  • Technical review completed by expert(s)
  • Technical reviewer feedback incorporated
  • All code verified for correctness
  • Technical accuracy checklist passed (technical-accuracy-checklist.md)
  • Security best practices followed (security-best-practices-checklist.md)
  • Performance considerations addressed (performance-considerations-checklist.md)

Editorial Review

  • Copy editing completed
  • Grammar and spelling checked
  • Readability checklist passed (readability-checklist.md)
  • Inclusive language checklist passed (inclusive-language-checklist.md)
  • Terminology consistency verified
  • Style guide compliance confirmed

Structure and Organization

  • Chapter flow is logical
  • Learning progression makes sense (prerequisite-clarity-checklist.md)
  • Chapters buildskills incrementally
  • No knowledge gaps or circular dependencies
  • Each chapter has clear learning objectives (learning-objectives-checklist.md)

Visual Elements

  • All diagrams finalized and clear (diagram-clarity-checklist.md)
  • All screenshots high quality (screenshot-quality-checklist.md)
  • All images at required resolution (300 DPI for print)
  • All figures have descriptive captions
  • Alt text provided for accessibility (accessibility-checklist.md)
  • All cross-references validated (validate-cross-references task)
  • All internal links work
  • All external URLs tested and accessible
  • All citations accurate (citation-accuracy-checklist.md)
  • Bibliography/references complete
  • Code repository links functional

Index and Glossary

  • Index comprehensive (index-completeness-checklist.md)
  • Index cross-references accurate
  • Glossary complete (glossary-accuracy-checklist.md)
  • Glossary terms used consistently
  • Index and glossary cross-referenced

Publisher-Specific Requirements

  • Publisher formatting guidelines followed
  • Manning MEAP checklist passed (if applicable: manning-meap-checklist.md)
  • O'Reilly format checklist passed (if applicable: oreilly-format-checklist.md)
  • PacktPub submission checklist passed (if applicable: packtpub-submission-checklist.md)
  • Self-publishing standards met (if applicable: self-publishing-standards-checklist.md)
  • Required metadata provided
  • Cover image finalized (if self-publishing)
  • All necessary permissions obtained
  • Copyright notices included
  • License information accurate
  • No copyright violations
  • Plagiarism check completed

Final Polish

  • Page breaks appropriate (if applicable)
  • Headers and footers correct
  • Table of contents accurate with correct page numbers
  • List of figures/tables accurate (if included)
  • Consistent formatting throughout
  • No [TK] or [TODO] placeholders remaining

Testing

  • Sample chapters reviewed by beta readers
  • Feedback incorporated from beta readers
  • Code examples tested by independent testers
  • Installation instructions verified by testers
  • Exercises tested for appropriate difficulty (exercise-difficulty-checklist.md)

Backup and Version Control

  • Complete manuscript backed up
  • All source files (diagrams, code, etc.) backed up
  • Final version clearly labeled
  • Version control history preserved
  • Submission package created

Pre-Submission Verification

  • Manuscript compiles/builds without errors
  • Preview generated and reviewed
  • Sample read-through completed
  • All checklists from this list passed
  • Final proofread completed
  • Ready for submission

Post-Submission Preparation

  • Errata page prepared (for tracking post-publication corrections)
  • Author contact information current
  • Book website ready (if applicable)
  • Marketing materials prepared
  • Social media announcement ready