This guide aims to maintain consistency and uphold quality standards in the content of My CFI Book. Adherence to these guidelines is required by contributors. Users making personal changes for their sole use are encouraged, but not required to comply.
Table of Contents
- Summary of the Writing Guidelines
- Abbreviations
- Don’t Repeat Yourself (The DRY Principle)
- Point of View
- Personal Bias
- “Student” Versus “Learner”
- Headings
- Definitions
- Ordered and Unordered Lists
- Audio and Video
- Images
- External References
- Cross-References to My CFI Book Pages
- Miscellaneous Guidelines
Summary of the Writing Guidelines
- Be Concise: Ensure each word and sentence serves a clear purpose.
- Keep it Simple: Use straightforward language that is easy to understand.
- Make it Valuable: Content should be informative and add value to the reader.
Every word should have a purpose. Every sentence should add value. Everything else is unnecessary.
Abbreviations
- Listed Abbreviations: Common aviation abbreviations appearing in the Abbreviations Used page are permissible.
- Unlisted Abbreviations: Abbreviations not defined in the “Abbreviations Used” page must be spelled out at first use in every Level 1 Heading (H1) section that it is to be used. This ensures that it is spelled out when the section is used in a lesson plan.
Don’t Repeat Yourself (The DRY Principle)
- Principle Overview: The DRY principle advocates for avoiding repetition. Content should not redundantly cover topics or instructions that have been previously addressed.
- Example: It is unnecessary to describe the proper visual scanning and traffic-clearing techniques with every flight maneuver.
- Suggestions: Utilize “Cross-References” to link related book pages, reducing the need for repetition and aiding in website navigation.
Note: See the “Cross-References” section for information on linking related book pages together.
Point of View
Most of My CFI Book is written using the third-person point of view. Words like “I” and “you” should be avoided.
Specifics of POV Usage
- First-Person Writing: This perspective uses pronouns like “I”, “me”, “we”, and “us”. It is reserved for quotations, examples, or mnemonics.
- Second-Person Writing: Used for imperative sentences, often in the format of direct commands or procedural steps. Second-person writing is used when outlining the steps of a procedure (e.g., “[You] Do this and then this.”). The “you” is implied but most often omitted.
- Third-Person Writing: Uses pronouns such as “he”, “she”, “it”, “they”, “him”, “her”, “his”, and “them”. This is the standard form for the majority of the book’s content.
Personal Bias
- Guiding Principle: My CFI Book presents an unbiased presentation of content. It does not endorse one “correct” method or procedure over others. Instead, it aims to provide a balanced view of all acceptable approaches.
- Equitable Presentation: When discussing procedures, techniques, or methodologies, ensure that all recognized and acceptable methods are presented equally. Avoid personal preferences or subjective judgments.
- Verification of Content: Any material that might be subject to debate or contention should be thoroughly researched and backed by credible, published sources.
“Student” Versus “Learner”
In keeping with the Aviation Instructor’s Handbook, “learner” is the preferred language when referring to persons receiving instruction. “Student” must be used when referring only to pilots who hold or are receiving training for a Student Pilot certificate.
Headings
Overview of HTML Headings
- Levels of Headings: HTML provides six levels of headings, ranging from H1 to H6. H1 represents the highest level of importance, while H6 is the least.
- Purpose of Headings in My CFI Book: Headings are utilized to organize and separate blocks of text into distinct sections, making the content more readable and navigable
Hierarchical Structure of Headings
- Sequential Use of Headings: Headings in My CFI Book follow a strict hierarchical order.
- An H2 heading is used only under an H1 section.
- An H3 heading is used under an H2 section, and so on.
- Reasons for Consistency in Headings: The hierarchical structure ensures a logical flow of information and helps maintain consistency throughout the book. The lesson plans and slideshow rely on the hierarchical structure to present content.
Definitions
- Primary Location for Definitions: On pages with multiple terms, a dedicated section for definitions is provided at the beginning of the page.
- Order of Definitions: These definitions are organized alphabetically to facilitate easy reference and learning.
- In-Text Definitions: Definitions that appear within the main body of the text on any page are highlighted in bold for emphasis.
- Pages with Examples: Principles of Flight and Weight and Balance.
Ordered and Unordered Lists
Preference for List Types
- Unordered Lists (Bullet Points): Preferred for most scenarios. Use bullet points when listing items that do not require a specific order or sequence.
- Ordered (Numbered) Lists: Employ numbered lists for items that need to be presented in a specific order or sequence, particularly when the order carries significance.
Use of Inline Lists
- Inline Lists for Brevity: Use inline lists when listing items that are brief and concise. This format is suitable for lists within a sentence or paragraph without disrupting the flow of text.
- Example: “Performance-based objectives consist of three elements: (1) a description of the skill or behavior, (2) conditions, and (3) criteria.”
How to Format a List
- Key Phrases: Bold the key phrase at the beginning of each item for emphasis.
- Explanations: Follow each bolded phrase with a brief explanation.
- Alignment: Ensure even spacing and alignment for readability.
- Punctuation: If the explanations form sentences, end each with a period.
- Consistency: Use all sentences or all fragments, not a mixture.
- Length: Avoid making bullet points so long that they look like paragraphs.
Note: The list provides an example as well as guidance.
Audio and Video
General Policy for Multimedia Content
- Hosting Requirements: Multimedia content, including videos and images, must be hosted either on MyCFIBook.com servers or on its official YouTube channel.
- Compliance: Any multimedia used must strictly adhere to intellectual property laws and not violate the Terms and Conditions agreement.
- Linked Sources: External links to multimedia content will only be made to credible sources such as the AOPA or government entity.
Process for Submitting Multimedia
- Approval: If you wish to contribute multimedia content, it must first be approved.
- Approval Procedure:
- Fill out the contact form available on MyCFIBook.com.
- Specify the nature and content of the multimedia in the request.
- Await approval or further instructions from the My CFI Book team.
Images
Creation and Hosting of Images
- Unique Creation: All images used in My CFI Book must be originally created for this specific purpose. No external or previously published images are allowed.
- Hosting Requirements: Images must be hosted on the MyCFIBook.com servers.
Preferred Image Style and Format
- Use of Line-Art Images: Preferably, images should be line-art style. This makes it easier for instructors to replicate them on a marker board or notepad during instruction.
- Creation and Exporting Process:
- Create images using Adobe Illustrator.
- Export images in SVG (Scalable Vector Graphics) format for optimal quality and scalability.
External References
- Placement: References should be placed immediately following level-one headings (H1) on a page.
- Starting Phrase: Begin the reference line with either “References:” or “Reference:”, depending on whether there are one or multiple sources cited.
- Separation of Multiple References: When listing multiple references, separate each with a comma.
- Example: References: 14 CFR 1.1, AIM 7-1-15, AC 61-65.
- In-Text References: When referencing within the text, use the following formats:
- A Single Reference: Use “(ref: ***)“, where *** is the reference.
- Multiple References: Use “(refs: ***, ***)”, where *** represents each reference.
- Example: 15 hours of flight training is required (ref: 14 CFR 61.311).
- Broad Applicability: For widely known and accepted aviation content, avoid citing specific textbooks or publishers. This is to ensure that the references are applicable to all instructors and curricula, accommodating varied preferences and requirements.
Types of External References
Note: Links are automatically generated for each reference if they are written to the following standards.
Types of references in order of listing priority:
- Federal Aviation Regulations (Example: “14 CFR Part 91” or “14 CFR 91.3”)
- Aeronautical Information Manual (Example: “AIM 4-3-1”; Chapter-Section-Heading; Heading is optional)
- Pilot/Controller Glossary
- Advisory Circulars (Example: “AC 68-1”; Do not include the revision letter)
- Flight Standards Information Management System (Example: “FSIMS 3-2-1”; Volume-Chapter-Section)
- FAA Orders and Notices (Example: “FAA Order 8100.8”; same for Notices)
- Special Airworthiness Information Bulletins (Example: “SAIB CE-10-21”)
- FAA Policy Statements (Example: “FAA Policy Statement 2019-06184”; Document Number)
- Legal Interpretations and Chief Counsel’s Opinions (Example: “Grayson-3 (2010) Legal Interpretation”)
- Information for Operators (Example: “InFO 14010”)
- Safety Alerts for Operators (Example: “SAFO 19001”)
- FAA Forms (Example: FAA Form FAA 7233-4″)
- FAA Safety Briefing Issues (Example: “FAA Safety Briefing Jan/Feb 2019”)
- Airman Certification Standards (Example: “FAA-S-ACS-8”; Do not include the revision letter)
- Practical Test Standards (Example: “FAA-S-8081-6”; Do not include the revision letter)
- ACS Companion Guide for Pilots (Example: “FAA-G-ACS-2”; Do not include the revision letter)
- Aeronautical Chart User’s Guide (links to both VFR and IFR)
- Chart Supplements
Notes:
- All other sources can be appended to the end of the list. Links will not be automatically generated.
- Legal Interpretations and Chief Counsel’s Opinions must be hosted by MyCFIBook.com to generate a link.
Cross-References to My CFI Book Pages
- Purpose: Utilize cross-references to other pages within My CFI Book to avoid content duplication and to facilitate easy navigation for readers.
- Formatting and Sequence:
- Standard Format: “Related: Book Title: Heading Title”
- Heading Title: Optional when referring to a full page, such as an appendix.
- Example: Related: Assessment and Critique: Oral Assessment
- Hyperlinking:
- Linking to Pages: Include a hyperlink in the reference for quick access.
- Linking to Specific Sections: If referring to a particular section, use an HTML bookmark (e.g., “/#value”) to direct readers to the exact location.
Miscellaneous Guidelines
Denoting Specific Content for Certain User Groups
- CFI/CFII Specific Content: Mark content specifically applicable to Certified Flight Instructors or Certified Flight Instrument Instructors with “[CFI]” or “[CFII]” respectively.
- IFR/VFR Operations: Indicate content relevant to Instrument Flight Rules (IFR) or Visual Flight Rules (VFR) with “[IFR]” or “[VFR]” accordingly.
- AMEL/ASEL Operations: For content applicable to Airplane Multi-Engine Land (AMEL) or Airplane Single-Engine Land (ASEL), use “[ASEL]”, “[AMEL]”, or “[ASEL, AMEL]” as appropriate.
Use of Call Signs and Checklist Items
- Example Communications: Replace actual tail numbers with “[call sign]” in example communications to maintain generality.
- Checklist Items: Responses in checklist items should be in uppercase (e.g., “OFF” instead of “off”) for clarity and emphasis.
Language and Precision in Writing
- Avoid Redundant Phrases: Refrain from using phrases like “etcetera” or “etc.” as they add no value to the content.
- Appropriate Precision: Use the term “instructor” instead of “flight instructor” when the content is also applicable to a ground instructor, to maintain relevance and inclusivity.