Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
Technical Communications: Planning  <ul><li>General Project Planning </li></ul><ul><ul><li>Purpose </li></ul></ul><ul><ul>...
Technical Communications: Planning  <ul><li>Analysis </li></ul><ul><ul><li>Required Information and Documents </li></ul></...
Technical Communications: Planning  <ul><li>Tasks </li></ul><ul><ul><li>Compose a List of User Tasks </li></ul></ul><ul><u...
Technical Communications: Planning  <ul><li>Learning Stages </li></ul><ul><ul><li>How Users Learn About the Product </li><...
Technical Communications: Planning  <ul><li>Collect User Details </li></ul><ul><ul><li>Define Product Users and Their Task...
Technical Communications: Planning  <ul><li>Environments and Documentation Ergonomics </li></ul><ul><ul><li>Plan the ‘Phys...
Technical Communications: Planning  <ul><li>Environments and Documentation Ergonomics </li></ul><ul><ul><li>Is There a Nee...
Technical Communications: Planning  <ul><li>Documentation Plan </li></ul><ul><ul><li>Essential Part of Quality Control  </...
Technical Communications: Planning  <ul><li>Documentation Plan (Documentation Services) </li></ul><ul><ul><li>Research  </...
Technical Communications: Planning  <ul><li>Documentation Plan (Documentation Services) </li></ul><ul><ul><li>Document Val...
Technical Communications: Planning  <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Product Background </li></ul...
Technical Communications: Planning  <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Scope </li></ul></ul><ul><ul...
Technical Communications: Planning  <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Information Sources </li></u...
Technical Communications: Planning  <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Draft Review </li></ul></ul>...
Technical Communications: Planning  <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>List of Reviewers </li></ul>...
Technical Communications: Planning  <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Packaging and Format </li></...
Technical Communications: Planning  <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Documentation Schedule </li>...
Technical Communications: Planning  <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Document Control and Distrib...
Technical Communications: Planning  <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Knowledge Transfer Requireme...
Technical Communications: Planning  <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Assumptions </li></ul></ul><...
Technical Communications: Planning  <ul><li>Documentation Plan (Assumptions) </li></ul><ul><ul><li>2) Information sources ...
Technical Communications: Planning  <ul><li>Documentation Plan (Assumptions) </li></ul><ul><ul><li>3) Any changes to the s...
Technical Communications: Planning  <ul><li>Documentation Plan (Assumptions) </li></ul><ul><ul><li>5) The writer will inte...
Technical Communications: Planning  <ul><li>Documentation Plan (Assumptions) </li></ul><ul><ul><ul><li>Once management has...
Upcoming SlideShare
Loading in …5
×

Technical Comms Planning Nf

869 views

Published on

Technical Communications: Planning

Published in: Business
  • Be the first to comment

Technical Comms Planning Nf

  1. 1. Technical Communications: Planning <ul><li>General Project Planning </li></ul><ul><ul><li>Purpose </li></ul></ul><ul><ul><li>Objective </li></ul></ul><ul><ul><li>Reader Profile </li></ul></ul><ul><ul><li>Scope of Subject </li></ul></ul><ul><ul><li>Project Schedule </li></ul></ul>
  2. 2. Technical Communications: Planning <ul><li>Analysis </li></ul><ul><ul><li>Required Information and Documents </li></ul></ul><ul><ul><li>Document Total Product and How It is Used </li></ul></ul><ul><ul><li>Integrate Software, Marketing Material, Technical Documentation, Training Material, and Customer Support Information—No Info Gaps or Conflicts </li></ul></ul><ul><ul><li>E.g., Training Needs Analysis Performed at Same Time as Documentation Planning </li></ul></ul>
  3. 3. Technical Communications: Planning <ul><li>Tasks </li></ul><ul><ul><li>Compose a List of User Tasks </li></ul></ul><ul><ul><li>Determine the Task Purpose and Sequence </li></ul></ul><ul><ul><li>Task Prerequisites </li></ul></ul><ul><ul><li>Task Schedule and Frequency </li></ul></ul><ul><ul><li>Required Sub-Tasks </li></ul></ul>
  4. 4. Technical Communications: Planning <ul><li>Learning Stages </li></ul><ul><ul><li>How Users Learn About the Product </li></ul></ul><ul><ul><li>How Does the Information Interface and Information Components Evolve </li></ul></ul><ul><ul><li>What Information Becomes More/Less Important and Useful over Time </li></ul></ul><ul><ul><li>Provide Suitable and Consistent Documentation for All Phases of the User’s Learning Curve </li></ul></ul>
  5. 5. Technical Communications: Planning <ul><li>Collect User Details </li></ul><ul><ul><li>Define Product Users and Their Tasks </li></ul></ul><ul><ul><li>Work with Product Developers, Product Managers, Marketing, Training, Customer Service People, and Actual Users, if Possible, to Agree on a Unified User Profile </li></ul></ul><ul><ul><li>Group Users for Each Document in a Set </li></ul></ul><ul><ul><li>Determine the Knowledge Level for Each User Profile (Computers, Task at Hand, Similar Products, Language and Culture) </li></ul></ul>
  6. 6. Technical Communications: Planning <ul><li>Environments and Documentation Ergonomics </li></ul><ul><ul><li>Plan the ‘Physicality’ of the Info Interface and Delivery </li></ul></ul><ul><ul><li>Analyze the User’s Physical Working Environment </li></ul></ul><ul><ul><li>Determine the Need for Print, Binding, Online Documentation, and Multimedia </li></ul></ul><ul><ul><li>Determine the Need for Direct User Access (Pull) or Delivery (Push) and Process Trigger Points for More Information </li></ul></ul>
  7. 7. Technical Communications: Planning <ul><li>Environments and Documentation Ergonomics </li></ul><ul><ul><li>Is There a Need for User Input? </li></ul></ul><ul><ul><li>What About Notification Methods and Schedules? </li></ul></ul><ul><ul><li>Documentation Should Complement, Be Consistent with, and Refer to User Information Available in the Graphical User Interface (GUI) </li></ul></ul>
  8. 8. Technical Communications: Planning <ul><li>Documentation Plan </li></ul><ul><ul><li>Essential Part of Quality Control </li></ul></ul><ul><ul><li>Describes Scheduling, Developing, and Testing Documentation (Product Support Information) </li></ul></ul><ul><ul><li>Provides a Project Roadmap That May Change as Project Evolves </li></ul></ul><ul><ul><li>Keeps Documentation Team Members In-Step </li></ul></ul>
  9. 9. Technical Communications: Planning <ul><li>Documentation Plan (Documentation Services) </li></ul><ul><ul><li>Research </li></ul></ul><ul><ul><li>Interviewing </li></ul></ul><ul><ul><li>Testing (e.g., Software with a GUI Interface) </li></ul></ul><ul><ul><li>Editing </li></ul></ul><ul><ul><li>Writing </li></ul></ul><ul><ul><li>Formatting, Layout, Graphics, and Multimedia </li></ul></ul><ul><ul><li>Draft Review Preparation, Coordination, and Administration </li></ul></ul>
  10. 10. Technical Communications: Planning <ul><li>Documentation Plan (Documentation Services) </li></ul><ul><ul><li>Document Validation (Content and Version) </li></ul></ul><ul><ul><li>Documentation Control and Standards </li></ul></ul><ul><ul><li>Production Editing and Coordination </li></ul></ul><ul><ul><li>Vendor Coordination (if Applicable) </li></ul></ul><ul><ul><li>Project Management (for Documentation Tasks) </li></ul></ul><ul><ul><li>Document Packaging and Distribution </li></ul></ul>
  11. 11. Technical Communications: Planning <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Product Background </li></ul></ul><ul><ul><li>Product Description </li></ul></ul><ul><ul><li>Business Case </li></ul></ul><ul><ul><li>Purpose </li></ul></ul>
  12. 12. Technical Communications: Planning <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Scope </li></ul></ul><ul><ul><li>Intended Audience </li></ul></ul><ul><ul><li>Related Documentation </li></ul></ul><ul><ul><li>Documentation Producers and Administrators </li></ul></ul>
  13. 13. Technical Communications: Planning <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Information Sources </li></ul></ul><ul><ul><li>Product Development Resource </li></ul></ul><ul><ul><li>Customer Input Resource </li></ul></ul>
  14. 14. Technical Communications: Planning <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Draft Review </li></ul></ul><ul><ul><li>Conflict Resolution </li></ul></ul>
  15. 15. Technical Communications: Planning <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>List of Reviewers </li></ul></ul><ul><ul><li>Document Preparation </li></ul></ul>
  16. 16. Technical Communications: Planning <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Packaging and Format </li></ul></ul><ul><ul><li>Information Strategy </li></ul></ul>
  17. 17. Technical Communications: Planning <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Documentation Schedule </li></ul></ul><ul><ul><li>Documentation Contents </li></ul></ul><ul><ul><li>Definitions, Acronyms, and Abbreviations </li></ul></ul>
  18. 18. Technical Communications: Planning <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Document Control and Distribution </li></ul></ul>
  19. 19. Technical Communications: Planning <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Knowledge Transfer Requirements </li></ul></ul>
  20. 20. Technical Communications: Planning <ul><li>Documentation Plan Headings </li></ul><ul><ul><li>Assumptions </li></ul></ul><ul><ul><li>1) The writing effort for this project depends on adherence to the published software development schedule, availability of technical input to the writer, and thorough and timely reviews of all drafts. </li></ul></ul>
  21. 21. Technical Communications: Planning <ul><li>Documentation Plan (Assumptions) </li></ul><ul><ul><li>2) Information sources allocate an appropriate amount of time within the software development schedule to meet with the writer for thorough and accurate information gathering during the initial stages, and confirm the thoroughness and accuracy of information on a timely basis throughout the draft review process. Conflicts regarding draft documentation content are resolved in a timely and professional manner . </li></ul></ul>
  22. 22. Technical Communications: Planning <ul><li>Documentation Plan (Assumptions) </li></ul><ul><ul><li>3) Any changes to the software development schedule or scope of the project will mean a change in the documentation schedule. </li></ul></ul><ul><ul><li>4) The main sources of information for the documentation are design and functional specifications, access to engineers, developers, operations staff, managers, marketing representatives, customer representatives (including external customers), testing results, existing documentation, the hardware and software, and so forth. </li></ul></ul>
  23. 23. Technical Communications: Planning <ul><li>Documentation Plan (Assumptions) </li></ul><ul><ul><li>5) The writer will interview the appropriate people for relevant information, and will have regular access to them on an ‘as- needed’ basis. </li></ul></ul><ul><li>6) The writer agrees to provide, for review: a rough draft, a first draft, and a signoff draft of the document. To facilitate the draft review process, and to minimize extensive changes during review and production, management and staff agree to the following : </li></ul><ul><ul><ul><ul><li>Managers will delegate members of their group to review and to provide comments regarding the draft document. </li></ul></ul></ul></ul>
  24. 24. Technical Communications: Planning <ul><li>Documentation Plan (Assumptions) </li></ul><ul><ul><ul><li>Once management has signed off on the final version of the document, they will not see the document again until the document is copied and distributed (that is, they agree not to submit changes to the document during the production cycle). This minimizes changes made to the reproduction-quality copy. </li></ul></ul></ul><ul><ul><ul><li>Any changes to these assumptions, contents of the documentation, and/or delays in draft review response time, may necessitate a revision to this documentation plan. </li></ul></ul></ul>

×