SlideShare ist ein Scribd-Unternehmen logo
1 von 22
Pappas Consulting, LLC
 Survey the Available Resource,
 Analyze the Physical Article,
 Analyze the Functional Article,
 Assess the Content Requirement,
 Assess the Appropriate Content,
 Design the Document,
 Implement Tool Development over Data Mining,
 Implement the Writing Process based on
  available engineering and scheduled events,
 Perform Scheduled Reviews and Validations,
 Edit and Publish the Final Product.
   Assess the available resource.
     Drawing Package (As built Drawings, Integration
      Diagrams, and Functional Flows),
     Subject Matter Experts (Designers, Engineers,
      Maintainers),
     Physical Equipment (Article) for research.
   Assess the complexity of the article to be documented
     Information Discovery:
      ▪ Count the number of Systems,
      ▪ Count the number of Subsystems,
      ▪ Count the number of Line Replaceable Units (LRU),
      ▪ Count the number of LRUs that require Man-Machine
        Interface (MMI),
      ▪ Count the number of Controls and Indicators for each LRU
        that requires MMI,
      ▪ Identify the modes of operation for each LRU,
      ▪ Identify the Functions within each mode of operation for any
        one LRU.
   Develop a Top Down Physical Breakdown
    (TDPB) of the System and it's components
    represented with an indenture schema.
     Associate Attaching Hardware
     Associate Cables
     Associate Peculiar Support Meta-Data
     Associate Research Traceability to the NHA
     Associate a coded system for Data Sorts
   Perform Task Analysis using the S1000D Task Descriptions (at
    various levels of information discovery) for each item in the TDPB:
     System
     Subsystem
     MMI Controls and Indicators
     Functional Tests and Checks for LRUs with Modes of operation
     Operational Procedures
     Emergency Operation Procedures
     Preventive Maintenance Requirements
     Periodic Maintenance Requirements
     Repair Actions
     Disassembly and Assembly for items that might be provisioned
     Provisioning Parts Lists
     Special Tools and Test Equipment Requirements
     Consumable Material Requirements
     Peculiar Tasks as required...
   After assessing all possible content objects to be
    documented, this will produce the Data Module
    Requirements List (DMRL).
     Each item in the TDPB of the equipment should have a set
      of Tasks associated to it from the DMRL.
   Using the S1000D, assign SNS (Subject Numbering
    System) to each task.
     This will result in a system of data management whereby:
      ▪ Content objects can be sorted on task type or functional group,
      ▪ Content Object complexity can be predicted and assigned a
        performance weight,
      ▪ Content objects can be assigned to individuals and performance
        taken against every aspect of the TM under development,
      ▪ Content objects will enable the data designer to produce the
        skeletal XML code required for each content object,
      ▪ Earned value can be assessed against each Content object.
   To discuss system or subsystem functionality it is
    necessary to interpret and understand the
    Engineering Functional Flow diagrams.
   One step toward grouping equipment
    functionally is to use an S1000D SNS schema on
    the TDPB.
   Another technique used to communicate
    function is to associate cable runs as they apply
    to items in the TDPB.
     Ultimately the TDPB will represent the indentured
     schema in the vertical plane while the functional
     relationship between subsystems is expressed in the
     horizontal plane.
   Refine the DMRL using a Level of Repair
    Analysis (LORA).
     Implication: if LORA does not exist, perform LORA.
   Refine the Failure Mode tasks using the Failure
    Mode Effects and Critical Analysis (FMECA).
     Implication: if FMECA does not exist, perform
     FMECA.
   Refine Provisioning Lists using the
    Provisioning Documentation Analysis (PDA).
     Implication: if PCA does not exist, perform PCA.
   Using a Content Specification, create the
    outline of the document. When using XML,
    create the framed or unframed XML instance.
   Apply Business Rules to the TM Outline (or
    XML framework).
   Crosswalk all of the DMRL coded objects into
    the Outline (or XML framework).
   Use single point management of this Outline
    instance while populating it with content.
   Gather resource documentation and place it
    on a common server location.
     Engineering Drawings,
     Special Tools and Test Equipment Lists,
     Personnel Conduct of Training Documentation
      (CTD),
     Item Unique Identification (IUID) assessment.
   Create Content Object templates.
   Place Task Orders for each DMRL line item on
    the server for Team Members to work.
     Define the Entrance Criteria,
     Define the Exit Criteria,
      ▪ A Spreadsheet Tool works well.
     Provide the specification Resource,
     Provide GFI,
     Provide the content template.
 Based on the scheduled development of engineering subjects
  produce the work schedule for writing content objects.
 Assess milestone development against the document that
  supports a review cycle.
     30% typically exhibits the content data structure, the outline of
        subject matter, and all of the written administrative content derived
        from Business Rules and Regulations,
       70% typically exhibits the 30% criteria and 50% of the predicted page
        count,
       90% typically exhibits a complete TM minus engineering changes that
        have occurred throughout product development,
       The 90% product should support the Validation and Verification of the
        product against the actual equipment,
       Preliminary Draft typically exhibits a complete manual ready for
        Editor Review,
       Final Draft removes all of the preliminary markings and is attached to
        the DD-250 for delivery.
   Hire Technical Writers that can...(satisfy your
    requirement).
   Hire Illustrators that can...(satisfy your
    requirement).
   Hire a Data Designer that can...(satisfy your
    requirement).
   Implement the plan for technical manual
    development:
       Assign Tasks,
       Collect Page counts and progress weekly,
       Update the EVMS database weekly,
       Ensure team members have what they require to
        perform to tasks.
   Schedule program events for reviews.
     Perform reviews as scheduled.
 Successfully complete the project under budget
  and within schedule.
 Have a party!
   Over the past 15 slides several things were going
    on all at once; or at least staggered in parallel:
       Project planning and management,
       Data Design of the specified content,
       Content Development,
       Provisioning,
       Illustrating the manuals.
   It is necessary to permit the engineering product
    to drive these efforts when TM development
    occurs during development of the engineered
    article.
 The blow by blow litany of tasks to perform above only represents
  the end result of any one thing that must be achieved. The true
  nature of the beast is one that requires leadership and planning as
  well as, senior skill sets to guide the team in technical agility. All of
  which is supported by various skill levels (dependant upon who is
  available today). This complex skill set represents the performance
  model for your team. Whatever the skill mix of your team, it will
  equate to "how many hours per page" you perform.
 Therefore it is imperative that a knowledgeable writer (who has
  engaged at least 5 or more full programs) estimate the hours for
  such an undertaking. A very skilled team may operate at 5 hours per
  page while a newly incepted team engaging a learning curve may
  take 10 hours per page. An unskilled group may easily burn 16
  hrs/page.
 Efforts that also require the Logistics analysis could require an
  additional 8 hours per page.
 These estimates of course are subject to the skill level and mix of
  your team as well as, the level of complexity and available resource.
   Basic TM Approach (loosely on the 38784) for
    a Maintenance Manual.
   Broad System Description.
     Type of system and it’s function,
     The elements used to implement the system
      (aircraft, Ship, Truck),
     Common resources:
      ▪ Documents,
      ▪ Materials,
      ▪ Support Equipment.
   Physical Description.
     System Description of overall equipment
      placement,
     Equipment locations (LRUs).
      ▪ Supporting tables,
      ▪ Supporting Figures.
     Controls and Indicators.
      ▪ Supporting tables,
      ▪ Supporting Figures.
   Theory of Operation.
   Functional Description.
     Electrical power distribution.
      ▪ Primary Power Source,
      ▪ Power Conversion,
      ▪ AC Distribution,
      ▪ DC Distribution,
      ▪ Emergency Power System,
     Control Distribution for each Mode and Function.
      ▪ Signal Flow Discussion.
   Procedures.
     Auto Test (BIT/BYTE),
     Manual Test.
   Fault Isolation.
     If/Then Logic.
   Remove/Replace.
   Disassembly/Assembly.
   Repair.
   Diagrams.
     Block – Electrical,
     Elevation –Installation.
   Illustrated Parts Breakdown.
     Illustrated breakdown of each provisioned item,
     List of equipment coded out with ordering
     information.
      ▪ Stock Numbers,
      ▪ Parts numbers,
      ▪ SMR Codes.

Weitere ähnliche Inhalte

Ähnlich wie How to develop technical manuals

Qtp interview questions
Qtp interview questionsQtp interview questions
Qtp interview questionsRamu Palanki
 
Qtp interview questions
Qtp interview questionsQtp interview questions
Qtp interview questionsRamu Palanki
 
Knowledge-Based Analysis and Design (KBAD): An Approach to Rapid Systems Engi...
Knowledge-Based Analysis and Design (KBAD): An Approach to Rapid Systems Engi...Knowledge-Based Analysis and Design (KBAD): An Approach to Rapid Systems Engi...
Knowledge-Based Analysis and Design (KBAD): An Approach to Rapid Systems Engi...Elizabeth Steiner
 
DQ Product Usage Methodology Highlights_v6_ltd
DQ Product Usage Methodology Highlights_v6_ltdDQ Product Usage Methodology Highlights_v6_ltd
DQ Product Usage Methodology Highlights_v6_ltdDigendra Vir Singh (DV)
 
End to-end root cause analysis minimize the time to incident resolution
End to-end root cause analysis minimize the time to incident resolutionEnd to-end root cause analysis minimize the time to incident resolution
End to-end root cause analysis minimize the time to incident resolutionCleo Filho
 
FME World Tour 2015 - FME & Data Migration Simon McCabe
FME World Tour 2015 -  FME & Data Migration Simon McCabeFME World Tour 2015 -  FME & Data Migration Simon McCabe
FME World Tour 2015 - FME & Data Migration Simon McCabeIMGS
 
data structures and its importance
 data structures and its importance  data structures and its importance
data structures and its importance Anaya Zafar
 
part 1 - intorduction data structure 2021 mte.ppt
part 1 -  intorduction data structure  2021 mte.pptpart 1 -  intorduction data structure  2021 mte.ppt
part 1 - intorduction data structure 2021 mte.pptabdoSelem1
 
Data mining model for the data retrieval from central server configuration
Data mining model for the data retrieval from central server configurationData mining model for the data retrieval from central server configuration
Data mining model for the data retrieval from central server configurationijcsit
 
The truth about_technical_manuals
The truth about_technical_manualsThe truth about_technical_manuals
The truth about_technical_manualsDan Pappas
 
Nose Dive into Apache Spark ML
Nose Dive into Apache Spark MLNose Dive into Apache Spark ML
Nose Dive into Apache Spark MLAhmet Bulut
 

Ähnlich wie How to develop technical manuals (20)

Kingshir-KADMS features
Kingshir-KADMS featuresKingshir-KADMS features
Kingshir-KADMS features
 
Qtp interview questions
Qtp interview questionsQtp interview questions
Qtp interview questions
 
Qtp interview questions
Qtp interview questionsQtp interview questions
Qtp interview questions
 
Knowledge-Based Analysis and Design (KBAD): An Approach to Rapid Systems Engi...
Knowledge-Based Analysis and Design (KBAD): An Approach to Rapid Systems Engi...Knowledge-Based Analysis and Design (KBAD): An Approach to Rapid Systems Engi...
Knowledge-Based Analysis and Design (KBAD): An Approach to Rapid Systems Engi...
 
Software engineering srs, dfd
Software engineering srs, dfdSoftware engineering srs, dfd
Software engineering srs, dfd
 
SE.pdf
SE.pdfSE.pdf
SE.pdf
 
DQ Product Usage Methodology Highlights_v6_ltd
DQ Product Usage Methodology Highlights_v6_ltdDQ Product Usage Methodology Highlights_v6_ltd
DQ Product Usage Methodology Highlights_v6_ltd
 
End to-end root cause analysis minimize the time to incident resolution
End to-end root cause analysis minimize the time to incident resolutionEnd to-end root cause analysis minimize the time to incident resolution
End to-end root cause analysis minimize the time to incident resolution
 
Computers in management
Computers in managementComputers in management
Computers in management
 
FME World Tour 2015 - FME & Data Migration Simon McCabe
FME World Tour 2015 -  FME & Data Migration Simon McCabeFME World Tour 2015 -  FME & Data Migration Simon McCabe
FME World Tour 2015 - FME & Data Migration Simon McCabe
 
Chapter 1- IT.pptx
Chapter 1- IT.pptxChapter 1- IT.pptx
Chapter 1- IT.pptx
 
data structures and its importance
 data structures and its importance  data structures and its importance
data structures and its importance
 
part 1 - intorduction data structure 2021 mte.ppt
part 1 -  intorduction data structure  2021 mte.pptpart 1 -  intorduction data structure  2021 mte.ppt
part 1 - intorduction data structure 2021 mte.ppt
 
Data mining model for the data retrieval from central server configuration
Data mining model for the data retrieval from central server configurationData mining model for the data retrieval from central server configuration
Data mining model for the data retrieval from central server configuration
 
Resume_Vellaiyan
Resume_VellaiyanResume_Vellaiyan
Resume_Vellaiyan
 
The truth about_technical_manuals
The truth about_technical_manualsThe truth about_technical_manuals
The truth about_technical_manuals
 
Performance testing wreaking balls
Performance testing wreaking ballsPerformance testing wreaking balls
Performance testing wreaking balls
 
Criteria For EA Tool Selection
Criteria For EA Tool SelectionCriteria For EA Tool Selection
Criteria For EA Tool Selection
 
Proposal with sdlc
Proposal with sdlcProposal with sdlc
Proposal with sdlc
 
Nose Dive into Apache Spark ML
Nose Dive into Apache Spark MLNose Dive into Apache Spark ML
Nose Dive into Apache Spark ML
 

Kürzlich hochgeladen

Histor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slideHistor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slidevu2urc
 
Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024The Digital Insurer
 
Exploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone ProcessorsExploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone Processorsdebabhi2
 
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
08448380779 Call Girls In Diplomatic Enclave Women Seeking MenDelhi Call girls
 
[2024]Digital Global Overview Report 2024 Meltwater.pdf
[2024]Digital Global Overview Report 2024 Meltwater.pdf[2024]Digital Global Overview Report 2024 Meltwater.pdf
[2024]Digital Global Overview Report 2024 Meltwater.pdfhans926745
 
Slack Application Development 101 Slides
Slack Application Development 101 SlidesSlack Application Development 101 Slides
Slack Application Development 101 Slidespraypatel2
 
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...Drew Madelung
 
IAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI SolutionsIAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI SolutionsEnterprise Knowledge
 
Driving Behavioral Change for Information Management through Data-Driven Gree...
Driving Behavioral Change for Information Management through Data-Driven Gree...Driving Behavioral Change for Information Management through Data-Driven Gree...
Driving Behavioral Change for Information Management through Data-Driven Gree...Enterprise Knowledge
 
The Codex of Business Writing Software for Real-World Solutions 2.pptx
The Codex of Business Writing Software for Real-World Solutions 2.pptxThe Codex of Business Writing Software for Real-World Solutions 2.pptx
The Codex of Business Writing Software for Real-World Solutions 2.pptxMalak Abu Hammad
 
2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...Martijn de Jong
 
What Are The Drone Anti-jamming Systems Technology?
What Are The Drone Anti-jamming Systems Technology?What Are The Drone Anti-jamming Systems Technology?
What Are The Drone Anti-jamming Systems Technology?Antenna Manufacturer Coco
 
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptxEIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptxEarley Information Science
 
Advantages of Hiring UIUX Design Service Providers for Your Business
Advantages of Hiring UIUX Design Service Providers for Your BusinessAdvantages of Hiring UIUX Design Service Providers for Your Business
Advantages of Hiring UIUX Design Service Providers for Your BusinessPixlogix Infotech
 
Raspberry Pi 5: Challenges and Solutions in Bringing up an OpenGL/Vulkan Driv...
Raspberry Pi 5: Challenges and Solutions in Bringing up an OpenGL/Vulkan Driv...Raspberry Pi 5: Challenges and Solutions in Bringing up an OpenGL/Vulkan Driv...
Raspberry Pi 5: Challenges and Solutions in Bringing up an OpenGL/Vulkan Driv...Igalia
 
Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...
Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...
Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...Miguel Araújo
 
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...
Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...Neo4j
 
Boost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivityBoost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivityPrincipled Technologies
 
Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024The Digital Insurer
 
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptxHampshireHUG
 

Kürzlich hochgeladen (20)

Histor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slideHistor y of HAM Radio presentation slide
Histor y of HAM Radio presentation slide
 
Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024Finology Group – Insurtech Innovation Award 2024
Finology Group – Insurtech Innovation Award 2024
 
Exploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone ProcessorsExploring the Future Potential of AI-Enabled Smartphone Processors
Exploring the Future Potential of AI-Enabled Smartphone Processors
 
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
08448380779 Call Girls In Diplomatic Enclave Women Seeking Men
 
[2024]Digital Global Overview Report 2024 Meltwater.pdf
[2024]Digital Global Overview Report 2024 Meltwater.pdf[2024]Digital Global Overview Report 2024 Meltwater.pdf
[2024]Digital Global Overview Report 2024 Meltwater.pdf
 
Slack Application Development 101 Slides
Slack Application Development 101 SlidesSlack Application Development 101 Slides
Slack Application Development 101 Slides
 
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
Strategies for Unlocking Knowledge Management in Microsoft 365 in the Copilot...
 
IAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI SolutionsIAC 2024 - IA Fast Track to Search Focused AI Solutions
IAC 2024 - IA Fast Track to Search Focused AI Solutions
 
Driving Behavioral Change for Information Management through Data-Driven Gree...
Driving Behavioral Change for Information Management through Data-Driven Gree...Driving Behavioral Change for Information Management through Data-Driven Gree...
Driving Behavioral Change for Information Management through Data-Driven Gree...
 
The Codex of Business Writing Software for Real-World Solutions 2.pptx
The Codex of Business Writing Software for Real-World Solutions 2.pptxThe Codex of Business Writing Software for Real-World Solutions 2.pptx
The Codex of Business Writing Software for Real-World Solutions 2.pptx
 
2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...2024: Domino Containers - The Next Step. News from the Domino Container commu...
2024: Domino Containers - The Next Step. News from the Domino Container commu...
 
What Are The Drone Anti-jamming Systems Technology?
What Are The Drone Anti-jamming Systems Technology?What Are The Drone Anti-jamming Systems Technology?
What Are The Drone Anti-jamming Systems Technology?
 
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptxEIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
EIS-Webinar-Prompt-Knowledge-Eng-2024-04-08.pptx
 
Advantages of Hiring UIUX Design Service Providers for Your Business
Advantages of Hiring UIUX Design Service Providers for Your BusinessAdvantages of Hiring UIUX Design Service Providers for Your Business
Advantages of Hiring UIUX Design Service Providers for Your Business
 
Raspberry Pi 5: Challenges and Solutions in Bringing up an OpenGL/Vulkan Driv...
Raspberry Pi 5: Challenges and Solutions in Bringing up an OpenGL/Vulkan Driv...Raspberry Pi 5: Challenges and Solutions in Bringing up an OpenGL/Vulkan Driv...
Raspberry Pi 5: Challenges and Solutions in Bringing up an OpenGL/Vulkan Driv...
 
Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...
Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...
Mastering MySQL Database Architecture: Deep Dive into MySQL Shell and MySQL R...
 
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...
Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...Workshop - Best of Both Worlds_ Combine  KG and Vector search for  enhanced R...
Workshop - Best of Both Worlds_ Combine KG and Vector search for enhanced R...
 
Boost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivityBoost PC performance: How more available memory can improve productivity
Boost PC performance: How more available memory can improve productivity
 
Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024Axa Assurance Maroc - Insurer Innovation Award 2024
Axa Assurance Maroc - Insurer Innovation Award 2024
 
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
04-2024-HHUG-Sales-and-Marketing-Alignment.pptx
 

How to develop technical manuals

  • 2.  Survey the Available Resource,  Analyze the Physical Article,  Analyze the Functional Article,  Assess the Content Requirement,  Assess the Appropriate Content,  Design the Document,  Implement Tool Development over Data Mining,  Implement the Writing Process based on available engineering and scheduled events,  Perform Scheduled Reviews and Validations,  Edit and Publish the Final Product.
  • 3. Assess the available resource.  Drawing Package (As built Drawings, Integration Diagrams, and Functional Flows),  Subject Matter Experts (Designers, Engineers, Maintainers),  Physical Equipment (Article) for research.
  • 4. Assess the complexity of the article to be documented  Information Discovery: ▪ Count the number of Systems, ▪ Count the number of Subsystems, ▪ Count the number of Line Replaceable Units (LRU), ▪ Count the number of LRUs that require Man-Machine Interface (MMI), ▪ Count the number of Controls and Indicators for each LRU that requires MMI, ▪ Identify the modes of operation for each LRU, ▪ Identify the Functions within each mode of operation for any one LRU.
  • 5. Develop a Top Down Physical Breakdown (TDPB) of the System and it's components represented with an indenture schema.  Associate Attaching Hardware  Associate Cables  Associate Peculiar Support Meta-Data  Associate Research Traceability to the NHA  Associate a coded system for Data Sorts
  • 6. Perform Task Analysis using the S1000D Task Descriptions (at various levels of information discovery) for each item in the TDPB:  System  Subsystem  MMI Controls and Indicators  Functional Tests and Checks for LRUs with Modes of operation  Operational Procedures  Emergency Operation Procedures  Preventive Maintenance Requirements  Periodic Maintenance Requirements  Repair Actions  Disassembly and Assembly for items that might be provisioned  Provisioning Parts Lists  Special Tools and Test Equipment Requirements  Consumable Material Requirements  Peculiar Tasks as required...
  • 7. After assessing all possible content objects to be documented, this will produce the Data Module Requirements List (DMRL).  Each item in the TDPB of the equipment should have a set of Tasks associated to it from the DMRL.  Using the S1000D, assign SNS (Subject Numbering System) to each task.  This will result in a system of data management whereby: ▪ Content objects can be sorted on task type or functional group, ▪ Content Object complexity can be predicted and assigned a performance weight, ▪ Content objects can be assigned to individuals and performance taken against every aspect of the TM under development, ▪ Content objects will enable the data designer to produce the skeletal XML code required for each content object, ▪ Earned value can be assessed against each Content object.
  • 8. To discuss system or subsystem functionality it is necessary to interpret and understand the Engineering Functional Flow diagrams.  One step toward grouping equipment functionally is to use an S1000D SNS schema on the TDPB.  Another technique used to communicate function is to associate cable runs as they apply to items in the TDPB.  Ultimately the TDPB will represent the indentured schema in the vertical plane while the functional relationship between subsystems is expressed in the horizontal plane.
  • 9. Refine the DMRL using a Level of Repair Analysis (LORA).  Implication: if LORA does not exist, perform LORA.  Refine the Failure Mode tasks using the Failure Mode Effects and Critical Analysis (FMECA).  Implication: if FMECA does not exist, perform FMECA.  Refine Provisioning Lists using the Provisioning Documentation Analysis (PDA).  Implication: if PCA does not exist, perform PCA.
  • 10. Using a Content Specification, create the outline of the document. When using XML, create the framed or unframed XML instance.  Apply Business Rules to the TM Outline (or XML framework).  Crosswalk all of the DMRL coded objects into the Outline (or XML framework).  Use single point management of this Outline instance while populating it with content.
  • 11. Gather resource documentation and place it on a common server location.  Engineering Drawings,  Special Tools and Test Equipment Lists,  Personnel Conduct of Training Documentation (CTD),  Item Unique Identification (IUID) assessment.  Create Content Object templates.
  • 12. Place Task Orders for each DMRL line item on the server for Team Members to work.  Define the Entrance Criteria,  Define the Exit Criteria, ▪ A Spreadsheet Tool works well.  Provide the specification Resource,  Provide GFI,  Provide the content template.
  • 13.  Based on the scheduled development of engineering subjects produce the work schedule for writing content objects.  Assess milestone development against the document that supports a review cycle.  30% typically exhibits the content data structure, the outline of subject matter, and all of the written administrative content derived from Business Rules and Regulations,  70% typically exhibits the 30% criteria and 50% of the predicted page count,  90% typically exhibits a complete TM minus engineering changes that have occurred throughout product development,  The 90% product should support the Validation and Verification of the product against the actual equipment,  Preliminary Draft typically exhibits a complete manual ready for Editor Review,  Final Draft removes all of the preliminary markings and is attached to the DD-250 for delivery.
  • 14. Hire Technical Writers that can...(satisfy your requirement).  Hire Illustrators that can...(satisfy your requirement).  Hire a Data Designer that can...(satisfy your requirement).
  • 15. Implement the plan for technical manual development:  Assign Tasks,  Collect Page counts and progress weekly,  Update the EVMS database weekly,  Ensure team members have what they require to perform to tasks.  Schedule program events for reviews.  Perform reviews as scheduled.  Successfully complete the project under budget and within schedule.  Have a party!
  • 16. Over the past 15 slides several things were going on all at once; or at least staggered in parallel:  Project planning and management,  Data Design of the specified content,  Content Development,  Provisioning,  Illustrating the manuals.  It is necessary to permit the engineering product to drive these efforts when TM development occurs during development of the engineered article.
  • 17.  The blow by blow litany of tasks to perform above only represents the end result of any one thing that must be achieved. The true nature of the beast is one that requires leadership and planning as well as, senior skill sets to guide the team in technical agility. All of which is supported by various skill levels (dependant upon who is available today). This complex skill set represents the performance model for your team. Whatever the skill mix of your team, it will equate to "how many hours per page" you perform.  Therefore it is imperative that a knowledgeable writer (who has engaged at least 5 or more full programs) estimate the hours for such an undertaking. A very skilled team may operate at 5 hours per page while a newly incepted team engaging a learning curve may take 10 hours per page. An unskilled group may easily burn 16 hrs/page.  Efforts that also require the Logistics analysis could require an additional 8 hours per page.  These estimates of course are subject to the skill level and mix of your team as well as, the level of complexity and available resource.
  • 18. Basic TM Approach (loosely on the 38784) for a Maintenance Manual.  Broad System Description.  Type of system and it’s function,  The elements used to implement the system (aircraft, Ship, Truck),  Common resources: ▪ Documents, ▪ Materials, ▪ Support Equipment.
  • 19. Physical Description.  System Description of overall equipment placement,  Equipment locations (LRUs). ▪ Supporting tables, ▪ Supporting Figures.  Controls and Indicators. ▪ Supporting tables, ▪ Supporting Figures.
  • 20. Theory of Operation.  Functional Description.  Electrical power distribution. ▪ Primary Power Source, ▪ Power Conversion, ▪ AC Distribution, ▪ DC Distribution, ▪ Emergency Power System,  Control Distribution for each Mode and Function. ▪ Signal Flow Discussion.
  • 21. Procedures.  Auto Test (BIT/BYTE),  Manual Test.  Fault Isolation.  If/Then Logic.  Remove/Replace.  Disassembly/Assembly.  Repair.
  • 22. Diagrams.  Block – Electrical,  Elevation –Installation.  Illustrated Parts Breakdown.  Illustrated breakdown of each provisioned item,  List of equipment coded out with ordering information. ▪ Stock Numbers, ▪ Parts numbers, ▪ SMR Codes.