ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity
BMAD-METHOD/expansion-packs/bmad-technical-writing/data/publisher-guidelines.md

9.8 KiB
Raw Blame History

Publisher Guidelines

Comprehensive publisher-specific requirements for technical book authors. This knowledge base provides formatting, submission, and process guidelines for major technical publishers.

PacktPub Publishing

Submission Requirements

Format:

  • Microsoft Word (.docx) or Markdown per author agreement
  • SharePoint-based submission system
  • Chapter-by-chapter delivery typical

Chapter Structure:

  • Chapter length: 20-30 pages typical
  • Learning objectives at beginning
  • Introduction section
  • Main content sections (3-6 major sections)
  • Summary or conclusion
  • Further reading or references

Style Guidelines:

  • Chicago Manual of Style (CMS) 16th or 17th edition
  • Second person ("you") perspective
  • Active voice preferred
  • Conversational but professional tone
  • British or American English (specify in contract)

Code Examples:

  • All code must be tested and functional
  • Syntax highlighting specified
  • Comments explain key concepts
  • Code repository required (GitHub typical)
  • Version numbers for all dependencies

Visual Elements:

  • Screenshots in PNG format (300 DPI minimum)
  • Figures numbered sequentially (Figure 1.1, 1.2, etc.)
  • Captions provided for all images
  • Diagrams clear and professional
  • Author typically provides raw images; publisher may reformat

Timeline:

  • Typical book: 6-12 months from contract to publication
  • Chapter milestones set by publisher
  • Technical review built into timeline
  • Author revision cycles after review

PacktPub Best Practices

  • Focus on practical, hands-on learning
  • Real-world examples valued
  • Step-by-step tutorials effective
  • Troubleshooting sections helpful
  • Clear learning objectives drive content
  • Beta reader feedback incorporated

Resources

O'Reilly Media

Submission Requirements

Format:

  • AsciiDoc or DocBook XML (Atlas platform)
  • Git-based workflow typical
  • Continuous integration with Atlas build system
  • HTML, PDF, and EPUB outputs generated automatically

Style Guidelines:

  • Chicago Manual of Style (CMS)
  • O'Reilly Word List for technical terms
  • Title case for headings
  • Consistent terminology critical
  • Technical precision valued

Code Examples:

  • Pygments language tags for syntax highlighting
  • Code callouts numbered
  • Tabs converted to spaces (4 spaces typical)
  • Line length limits (80 characters for print-friendly)
  • Code tested thoroughly

Structure Requirements:

  • Preface explains audience, prerequisites, conventions
  • Chapter hierarchy: chapter → sect1 → sect2 → sect3
  • Cross-references use proper xref syntax
  • Glossary and index terms marked during writing
  • Appendices for reference material

Visual Elements:

  • Vector formats preferred (EPS, PDF)
  • PNG for screenshots (high resolution)
  • Figure captions as complete sentences
  • Tables use proper markup
  • Diagrams professionally rendered

Review Process:

  • Technical review by external experts
  • Developmental editing
  • Copy editing
  • Production editing
  • Author reviews at each stage

O'Reilly Best Practices

  • Write for the "practical practitioner"
  • Examples from real-world scenarios
  • Deep technical detail valued
  • Comprehensive coverage expected
  • Authoritative voice appropriate
  • Future-proof content when possible

Resources

Manning Publications

Manning Early Access Program (MEAP)

MEAP Overview:

  • Chapters published as completed
  • Reader feedback during writing process
  • Community engagement valued
  • Revenue sharing starts with MEAP
  • Chapters must stand alone (readers may not have earlier chapters)

Format:

  • Microsoft Word or Markdown accepted
  • Manning's production team handles final formatting
  • Author voice strongly encouraged
  • Conversational tone valued

Style Guidelines:

  • Author personality and experience highlighted
  • "We" or "I" voice appropriate
  • Engaging, story-driven approach
  • Real-world scenarios and war stories
  • Humor and personality welcomed (within professional bounds)

Chapter Structure:

  • Context provided for standalone reading
  • Chapters in this chapter / Chapter summary
  • Margin notes or callouts for key points
  • "Try this" or hands-on moments
  • Questions to engage readers

Code Examples:

  • GitHub repository required
  • Code organized by chapter
  • README explains how to use examples
  • Tests included where appropriate
  • Version numbers specified

Visual Elements:

  • Diagrams enhance understanding
  • Screenshots annotated helpfully
  • Manning's art team may redraw diagrams
  • Figures integrated into narrative
  • Whiteboard-style diagrams often effective

Manning Best Practices

  • Write to your audience directly
  • Share your experience and expertise
  • Make content immediately practical
  • Engage readers with questions and challenges
  • Respond to MEAP reader feedback
  • Build community around your book

Resources

Self-Publishing Platforms

Amazon Kindle Direct Publishing (KDP)

Format:

  • EPUB, MOBI, or Word formats
  • Kindle Create tool available
  • Preview tools for different devices
  • DRM optional

Requirements:

  • Cover design (author provides or use KDP tools)
  • ISBN (Amazon provides free ASIN, or use your own ISBN)
  • Book description and keywords
  • Author bio
  • Pricing set by author (royalty tiers: 35% or 70%)

Best Practices:

  • Mobile-friendly formatting essential
  • Test on multiple Kindle devices/apps
  • Table of contents with links
  • Code formatting carefully tested
  • Images optimized for e-readers

Leanpub

Format:

  • Markdown or direct writing in Leanpub editor
  • Git integration available
  • Automatic PDF, EPUB, MOBI generation
  • Variable pricing model

Unique Features:

  • Publish while writing (MVP approach)
  • Reader feedback during writing
  • Bundle options (book + code + videos)
  • Automatic updates to readers
  • Coupons and promotional tools

Best Practices:

  • Minimum viable book to start (even a few chapters)
  • Iterate based on reader feedback
  • Keep readers updated with new content
  • Price competitively (suggested pricing guidance)
  • Market directly to your audience

Resources

General Publisher Considerations

Royalty Structures

  • Traditional publishers: 8-15% of net (after retailer cut)
  • Self-publishing: 35-70% of gross (varies by platform)
  • Advance payments vary widely (technical books: $5K-$25K typical, can be much higher for established authors)

Rights and Licensing

  • Traditional: publisher typically gets exclusive rights for term
  • Self-publishing: you retain all rights
  • Code licensing: often separate from book copyright
  • Translation rights negotiable

Marketing and Promotion

  • Traditional publisher provides some marketing, author expected to promote
  • Self-publishing: 100% author responsibility
  • Author platform important for both (blog, social media, speaking)
  • Technical community engagement valuable

Timeline Considerations

  • Traditional: 6-18 months from contract to publication
  • Self-publishing: author controls timeline (can publish immediately or over time)
  • Both: writing typically takes 6-12 months for comprehensive book

Choosing the Right Publisher

Traditional Publisher When:

  • You want professional editing and production
  • Marketing support desired
  • Credibility and imprint important
  • Established distribution channels valued
  • Royalty advance needed
  • Don't want to manage production details

Self-Publishing When:

  • You want full control
  • Higher per-book royalty important
  • Quick time to market needed
  • You have existing audience/platform
  • You want to retain all rights
  • Willing to handle production and marketing

Hybrid Approach:

  • Self-publish first to build audience
  • Traditional deal for expanded/updated version
  • Or reverse: traditional first, then self-publish later editions
  • Different books with different publishers

Submission Best Practices (All Publishers)

Proposal Elements

  • Book concept and unique value
  • Target audience definition
  • Competitive analysis
  • Author credentials and platform
  • Complete chapter outline
  • Sample chapters (1-2 chapters)
  • Marketing plan
  • Timeline estimate

Professional Presentation

  • Well-formatted proposal
  • Error-free writing
  • Realistic timeline
  • Understanding of market
  • Clear differentiators from competing books

Building Relationships

  • Network at conferences
  • Engage with publisher's community
  • Follow editors on social media
  • Understand each publisher's catalog
  • Tailor proposal to publisher's style

Resources and References

Style Guides

Author Communities

Tools

Legal and Rights