While we want this to be a fun, collaborative, and creative process, we still wish to produce a high-quality book we can all be proud of, and readers will be happy to purchase. Editing large numbers of chapters, each from various authors is a significant effort. We have expectations of our authors to ease the editing process and ensure a quality baseline.
What does the project expect of the authors?
- The authors must have an understanding of the technical material for the chapter that they are writing.
- The authors must follow the style and writing guidelines published in the GitHub repository.
- The authors must proofread their chapters at least three (3) times before submitting their final draft.
- The authors must be reachable by Slack, Discord, GitHub, or email during the editing process.
- The authors must yield to editors' discretion regarding content or style.
- The authors must write in American English. Native English speakers are responsible for their spelling and grammar. Non-native speakers may give their best effort and seek support from editors.
- The authors should assist each other with git and GitHub issues if they are able.
- The authors are responsible for the technical accuracy of their chapters.
- The authors must ensure their images are legible in black and white. When sent for physical publication, the publisher converts images from color to black and white. Images not using high contrast can be tough to interpret in black and white. Avoid using "dark mode" screenshots and use dark text on light or white backgrounds. Also, it is better to avoid using screenshots to convey concepts for those readers that may be vision impaired or relying upon a text reader.
- The authors must not use copyrighted materials, including images and memes, even if they may fall within creative commons or public domain.
- The authors must read, understand, and agree to the copyright agreement.
- The authors must not plagiarize.
The technical editor will be responsible for the technical content within designated sections of the book.
What does the project expect of the Technical Editors?
- Technical Editors are expected to have the expertise and experience to cover the topics in their section.
- Technical Editors will work with the authors who are writing for their section to ensure the content is accurate, cohesive, and fits with the other chapters in the section.
- Technical Editors will make content suggestions to the authors as necessary.
- Technical Editors will ensure that technical content meets the style guide expectations.
- Technical Editors will also be aware of the other sections' content and their chapter outlines, but not necessarily all of the content, to reference their content to the other chapters where appropriate.
- Technical editors will ensure that chapters are free from plagiarism.
The linguistic editor will make sure the content for the chapters is grammatically accurate.
What does the project expect of the Linguistic Editors?
- The linguistic editor is also responsible for ensuring the content follows the style guide and follows the book's "one voice" expectation. The book will need to read as if a single person wrote it to help maintain the continuity of thought, especially since the book is intended to be used as a textbook and for training.
- The linguistic editor will ensure that all material is correctly referenced.
- The linguistic editor will ensure that chapters are free from plagiarism.
The quality control person will make sure the examples and code samples are syntactically correct, technically correct, and follow best practice conventions for PowerShell code.
What does the project expect of the Quality Assurance Editors?
- Quality Assurance editors will ensure all of the code functions as expected, follows a standard syntax, and does not have any visible defects when displayed or printed.
- Quality Assurance editors will ensure that all material is referenced correctly.
- Quality Assurance editors will ensure that chapters are free from plagiarism.