2 Replies Latest reply on Nov 27, 2012 4:20 AM by Eugene Tyson

    How do you divide your manuals?

    gscortino1

      I have a large terchnical manual that is divided as follows:

      Chapters for each major technical topic such as Electrical, Mechanical etc. 

      Then Major Topics within each Chapter

      The end result would look like this_

       

      Mechanical Chapter

           Topic 1 - Covers

                Section 1 - Cover Assemblies

                Section 2- Cover Cleaning and Maintenance

                Section 3- Cover Removal and installation

       

      Electrical Chapter

           Topic 1-Wiring

               Section 1- Wiring Diagrams

               Section 2-Wiring Troubleshooting

               Section 3-Wiring Assemblies.

           Topic 2- Printed Circuit Boards

                Section 1-Power Boards

                Section 1-Control Boards

       

      I want to know how you do it.  Tell me how and why you divide your manuals. 

        • 1. Re: How do you divide your manuals?
          peter minneapolis Level 4

          You'll find good suggestions from the technical writers who participate on their profession's forum:


          To subscribe or unsubscribe via the World Wide Web, visit

                  http://lists.techwr-l.com/mailman/listinfo/techwr-l

          or, via email, send a message with subject or body 'help' to

                  techwr-l-request@lists.techwr-l.com

           

           

          HTH

           

           

          Regards,

           

           

          Peter

          _______________________

          Peter Gold

          KnowHow ProServices

           

          gscortino1 wrote:

           

          I have a large terchnical manual that is divided as follows:

          Chapters for each major technical topic such as Electrical, Mechanical etc. 

          Then Major Topics within each Chapter

          The end result would look like this_

           

          Mechanical Chapter

               Topic 1 - Covers

                    Section 1 - Cover Assemblies

                    Section 2- Cover Cleaning and Maintenance

                    Section 3- Cover Removal and installation

           

          Electrical Chapter

               Topic 1-Wiring

                   Section 1- Wiring Diagrams

                   Section 2-Wiring Troubleshooting

                   Section 3-Wiring Assemblies.

               Topic 2- Printed Circuit Boards

                    Section 1-Power Boards

                    Section 1-Control Boards

           

          I want to know how you do it.  Tell me how and why you divide your manuals. 

          • 2. Re: How do you divide your manuals?
            Eugene Tyson Adobe Community Professional & MVP

            I save each one as an individual file

            Topic_Covers.indd

            Cover Assemblies.indd

            Cover Cleaning and Maintenance.indd

            Cover Removal and INstallation.indd

             

            Electrical Chapter.indd

            Topic_Wiring.indd

            Wiriing Diagrams.indd

             

            Notice the way I don't include the Section #

             

            That's intentional in case a Section needs to move - there's no point in renumbering hundreds of documents.

             

             

            Then I compile all the files in a Book.

             

             

            I use the Book features to apply Topic & Section Numbers throughout the files, for example:

             

            In Wiring Diagrams.indd I'll set up a Style called "Section Number"

             

            You'll notice in the Bullets and Numbering I have used "Section ^H:" where "^H" denotes a chapter number.

             

            section.jpg