Appendix H — Project Notes
New chapters are are being prototyped for the updated online book. The intent is to bring the whole project up to the standard of actual published book.
H.1 ToDo List
H.2 Chapter Status
| Chapter | Draft Status |
|---|---|
| index.qmd | done |
| Preface.qmd | done |
| Introduction.qmd | done |
| Basic_concepts.qmd | done |
| Modified_Nodal_Analysis.qmd | done |
| MNA_with_python.ipynb | done for now, but need to update narrative and summary |
| resistive_networks.ipynb | done for now, but need to update narrative and summary |
| RLC_networks.ipynb | done for now, but need to update narrative and summary |
| Transfer_function.ipynb | done for now, but need to update narrative and summary |
| Transient_analysis.ipynb | done for now, but need to update narrative and summary |
| Mutual_inductance.ipynb | update narrative and summary |
| Initial_conditions.ipynb | update narrative and summary |
| Example problems | review all |
“done” means ready to commit a new version of the book.
H.3 Chapter Summary
Make the chapter summaries consistent.
- recap
- why this chapter is important
- Bulleted list of the most important points
H.4 Front Matter
The file index.qmd serves as the Front Matter normally found in a physical book. Quarto generates the table of contents.
Missing is a Table of Figures and Table of Tables.
H.5 Updates to change log
See Table B.2 Book Change History in appendix for detailed description of changes.
H.6 Editing
Which of these types of editors are needed for a technical book?
- Developmental editing
- Technical editing
- Copy editing
- Proofreading
Writing and publishing a technical book is a rigorous process because you aren’t just checking for grammar—you are ensuring technical accuracy and instructional clarity.
To produce a high-quality technical book, you actually need all four types of editors, as they each handle a different layer of the manuscript.
H.6.1 Developmental Editing
This is the “big picture” phase. A developmental editor looks at the structure, scope, and flow of the book.
- Their Focus: Does the order of chapters make sense? Is the difficulty curve too steep? Are there missing concepts that a reader would need to understand Chapter 5?
- Why it matters: It prevents you from writing 300 pages only to realize the core premise is confusing.
H.6.2 Technical Editing (Subject Matter Expert)
This is unique to technical publishing. A technical editor (often a peer in the industry) verifies the “truth” of your content.
- Their Focus: Does the code actually run? Are the architectural diagrams correct? Is the advice following current best practices?
- Why it matters: Technical readers are notoriously sensitive to errors. One broken code snippet can ruin the book’s credibility.
H.6.3 Copy Editing
Once the structure and technical facts are solid, the copy editor polishes the prose.
- Their Focus: Grammar, style, tone, and consistency. They ensure you use the same capitalization for “Web site” vs “website” throughout and check that your “Voice” is professional yet accessible.
- Why it matters: It removes distractions, allowing the reader to focus on learning the material rather than tripping over typos.
H.6.4 Proofreading
This is the final safety net before the book goes to print or digital distribution.
- Their Focus: Catching “orphans” or “widows” (stray lines of text), checking page numbers, ensuring images are aligned with their captions, and spotting any lingering typos missed in previous rounds.
- Why it matters: It’s the last chance to ensure the book looks polished and professional.
H.6.5 Summary of the Workflow
| Editor Type | Phase | Primary Goal |
|---|---|---|
| Developmental | Early / Drafting | Logical flow and structure |
| Technical | Mid / Review | Accuracy of code and concepts |
| Copy Editing | Late / Final Polish | Style, grammar, and readability |
| Proofreading | Final | Formatting and “last-look” errors |