Will You Add?
#1 in Business Subscribe Email Print

You are here: Home > Writing and Speaking > Writing and Speaking > Successful Documentation Projects - Part 2 of 3 - 'Specifying'

Tags

  • samples
  • learn
  • stylish
  • situation project
  • search engine
  • access information

  • Links

  • Used Car Inspection - Inspecting the Body
  • Search Engine Optimization Strategies - Reciprocal Linking Guidelines
  • De-Stressing in Flagstaff - Spas
  • Will You Add? - Successful Documentation Projects - Part 2 of 3 - 'Specifying'

    Cheap Personal Loans- Materializing Desires And That Too Cheaply
    Today money plays a pivotal role in anyone’s life. It is almost impossible to imagine life without money. So to make life easy and a lot better companies are providing cheap personal loans. These loans are meant for satisfying the day to day needs of the people i.e. the personal needs of the people. The cheap personal loans are handy for the people as they are available online which saves the processing fees to a great extent making this personal loan really cheap. These cheap personal loans can be used for any purposes like buying something, renovating your home or paying medical expenses.Cheap personal loans can be divided into two categories1> Secured cheap personal loans2> Unsecured cheap personal loansSecured cheap personal loansSecured cheap personal loans are a cheaper version of the personal loans. In secured personal loans the borrower has to mortgage something valuable to the lender as security. But this personal loan is really very cheap as the rate of interest is quite low and also the repayment tenure is quite long. Actually it varies between 3 to 25 years. The loan amount that can be borrowed here is about 125% of the value of the asset kept as collateral. Apart from this the borrower can choose between either fixed or variable rate of interest. In loans with fixed interest rates the rate of interest is fixed over the whole repayment tenure where as in the case of personal loans with variable interest rates the rates keeps on varying every month depending on the marke
    ents for the remainder of the project. You should also update the “Documentation Project Plan” document with this information.

    Estimating is always a difficult process, and there’s not really any sure-fire way of getting it right. Mostly it depends on the job and your experience. However, following are some guidelines that might help you.

    If you have records from previous projects, you might simply be able to estimate project duration based on these. You should try to compare the old subject material and topics with the new to make sure that the old times will be applicable to the new project. On p.174 of Managing Your Documentation Projects (1994), Hackos provides some potentially useful guidelines for comparing the complexity of various documentation projects.

    If, on the other hand, the project is entirely new, you will have no records to use as a guide (unless you have managed a similar project in the past). In this situation, project estimates will be very difficult to make.

    One possible method for estimating is:

    1. Compile a list of tasks, and record how many there are in your list.
    2. Compile a list of concepts that must be documented, and record how many there are in your list.
    3. From your list of tasks, select 10 that are representative of the rest (in terms of complexity, expected length, status of the relevant development, etc.), and of the same granularity (e.g., you can write a single topic for each).
    4. From your list of concepts, select 3 that are representative of the rest, and of the same granularity (e.g., you can write a single topic for each).
    5. Online Postcard Printing - Providing Efficient Printing Jobs
      Are you tired of scouting for commercial printing companies to handle your printing jobs? Are you tired of the thought that they will provide you with what you are looking for? Well maybe its time to make a change. Sit back and lean on your chair, face your computer and browse to the net. In this way you seek and search for a printer capable of answering all your printing needs. By means of computers and online services we easily get what we want.Among the beneficiaries that online services provide are the advertisers. This is because they could easily relay printing jobs to the online printers and let them do the rest of the jobs. The vital function of online services had persuaded commercial printing companies to expand their services online. This had made commercial printers to interact easily with their clients.Online postcard printing as among the many services offered online, had been capable of dealing with your postcard printing jobs. With just a single click of your mouse you are able to provide your printer with the files and specifications about your printing jobs without any hassles.As a provider of efficient printing jobs, online postcard printing provides the following benefits:•Easy online access – you need not to spend time walking around to look for your local printers, for with just a single click of your mouse you can have your printers right and there in front of you.•Smooth ordering process – purchasing your postcard prints is no longer hard to do. This is becau
      So you’re responsible for managing a documentation project. You know who your audience is, what they’re trying to achieve, how the product enables them to achieve it, and what the audience requires of the help. Now it’s time to spec out your intentions.

      NOTE: This is the second in a series of three articles outlining the key elements of a good user documentation process. (To read the first and third articles in this series, go to http://www.divinewrite.com/docoprocess1.htm and http://www.divinewrite.com/docoprocess3.htm.)

      State your goals

      Generically speaking, your goal statement should indicate that you hope to create a suite of documentation products that will satisfy audience requirements. Specifically, you’ll have a number of sub-goals. (TIP: It may help to remember that the goals you set here will need to be used to measure the success of your product through your own in-house testing as well as through evaluative user research.) Such sub-goals may include:

      • Ease of use
      • Accessibility
      • Helpfulness
      • Accuracy
      • Relevance
      • Comprehensiveness
      • Adherence to style guidelines
      • Correct spelling and punctuation
      Write your Concept Specifications

      Your goals set, you can start to contemplate what you’re going to produce. The first step is to create some concept specifications. Simply put, concepts specs are very high level overviews of what you’re proposing to produce. For example, your concept spec for the online help might state that you will be producing a product that allows the user to access information using a TOC, an Index, and a Find. It might suggest some possible GUI features of these elements, but it will not lay down requirements; just possibilities. The concept spec for your manuals might state that they will be professional looking, will contain many professionally drawn pictures, will have adequate white space, will be stylish, will be divided into chapters to match the task oriented nature of the online help, etc.

      Generally, the product you’re proposing could be implemented in a number of different ways. You should write one or more concept spec(s) for:

      • what components the documentation suite will consist of (online help, printed manuals, tutorials, overviews, etc.) – “Documentation Products Concept Specification”
      • the types of information your documentation will contain (e.g., the structure of the TOC, are you going to follow minimalism practices?) – “Documentation Content Concept Specification”
      • the functionality and user interface of your documentation suite (e.g., how it will work and how the audience will interact with it) – “Online Help User Interface Concept Specification”, “Printed Documentation User Interface Concept Specification”, etc.
      • the delivery method (how you will deliver the help to users and how you’ll update it)
      • what languages the documentation will be produced in
      Design some possible implementations

      Now that you’ve decided roughly what you’d like to produce, you can design some possible implementations of it. Your designs will be very high level and they may not actually work (they may actually be just paper prototypes).

      With most other considerations already finalised through your user requirements research, these implementations should only differ as a result of:

      • the technologies behind them
      • the tools used to create them
      • the overall look and feel
      You need to learn as much as possible about these things, in order to determine what is actually possible, successful, effective, etc. You should be aware of current trends, literature, white papers, etc. This information can be obtained from a variety of sources. Some good places to start include:

      • List servers
      • Conferences
      • Books
      • Other publications
      • Other writers
      • Other products
      Conduct usability testing on your prototypes

      Model (prototype) your designs for the decision makers and audience samples. This allows you to pick the best features from each design (and to determine priorities for them). Select a design (or merge multiple designs) that you believe best satisfies user requirements. This process may be iterative. At the end of this stage, you should know enough to detail exactly what you’ll be producing (including what help platform and tool you’ll be using).

      TIP: For details on possible research methods, take a look at Managing Your Documentation Projects by Hackos (1994) esp. pp.446-447, User and Task Analysis for Interface Design by Hackos & Redish (1998), Social Marketing: New Imperative for Public Health by Manoff (1985), Designing Qualitative Research 2nd Edition by Marshall & Rossman (1995), and “Conducting Focus Groups – A Guide for First-Time Users”, in Marketing Intelligence and Planning by Tynan & Drayton (1988).

      Write your Requirements Specifications

      Requirements specifications detail exactly what you must end up with. These specifications should contain as much detail as possible about the features and functionality of the documentation product (not how you’ll go about building it).

      Requirements specs are basically an evolution of your concept specs. Once you begin work on your requirements specs, the concept specs are effectively frozen. You should write one or more concept spec(s) for:

      • what components the documentation suite will consist of (online help, printed manuals, tutorials, overviews, etc.) – “Documentation Products Requirements Specification”
      • the types of information your documentation will contain (e.g., the structure of the TOC, are you going to follow minimalism practices?) – “Documentation Content Requirements Specification”
      • the functionality and user interface of your documentation suite (e.g., how it will work and how the audience will interact with it) – “Online Help User Interface Requirements Specification”, “Printed Documentation User Interface Requirements Specification”, etc.
      • the delivery method (how you will deliver the help to users and how you’ll update it)
      • what languages the documentation will be produced in
      Estimate Project Duration & Resources

      Once you’ve completed the requirements spec stage, you should know enough to accurately estimate the duration and resource requirements for the remainder of the project. You should also update the “Documentation Project Plan” document with this information.

      Estimating is always a difficult process, and there’s not really any sure-fire way of getting it right. Mostly it depends on the job and your experience. However, following are some guidelines that might help you.

      If you have records from previous projects, you might simply be able to estimate project duration based on these. You should try to compare the old subject material and topics with the new to make sure that the old times will be applicable to the new project. On p.174 of Managing Your Documentation Projects (1994), Hackos provides some potentially useful guidelines for comparing the complexity of various documentation projects.

      If, on the other hand, the project is entirely new, you will have no records to use as a guide (unless you have managed a similar project in the past). In this situation, project estimates will be very difficult to make.

      One possible method for estimating is:

      1. Compile a list of tasks, and record how many there are in your list.
      2. Compile a list of concepts that must be documented, and record how many there are in your list.
      3. From your list of tasks, select 10 that are representative of the rest (in terms of complexity, expected length, status of the relevant development, etc.), and of the same granularity (e.g., you can write a single topic for each).
      4. From your list of concepts, select 3 that are representative of the rest, and of the same granularity (e.g., you can write a single topic for each).
      5. Three Dumbest LLC Formation Mistakes
        I see a lot of dumb LLC formation mistakes. Maybe more than most people because I regularly teach a graduate tax class on LLC formation.Some of the mistakes are made by entrepreneurs and investors trying to save money on accountants and attorney fees. And I guess that’s okay--albeit penny- wise and pound-foolish.But you know what really irks me? Some of these mistakes in fact, most of them are made by attorneys and paralegal services… Professionals who should know better.But enough whining. Without further fanfare, here are the three dumbest mistakes that I see people make again, and again, and again.Mistake #1: Forgetting about Foreign LLC Registration RulesRead those tempting advertisements for Delaware or Nevada limited liability companies? The advertisements sound pretty good, but most small businesses shouldn’t use out-of-state llcs or for that matter out-of-state corporations.Here’s why: If you’re doing in business in, say, New York, you’re not going to be able to avoid state taxes by forming your llc in, say, Nevada. The tax and corporation laws in your state will require you to register your out-of- state, or foreign, llc in the states where your business operates. Those same laws will require you to pay state income taxes in the states where you earn your income.A couple more quick points: Large businesses do like Delaware for a variety of reasons—mostly having to with how sophisticated the Delaware chancellery court
        to access information using a TOC, an Index, and a Find. It might suggest some possible GUI features of these elements, but it will not lay down requirements; just possibilities. The concept spec for your manuals might state that they will be professional looking, will contain many professionally drawn pictures, will have adequate white space, will be stylish, will be divided into chapters to match the task oriented nature of the online help, etc.

        Generally, the product you’re proposing could be implemented in a number of different ways. You should write one or more concept spec(s) for:

        • what components the documentation suite will consist of (online help, printed manuals, tutorials, overviews, etc.) – “Documentation Products Concept Specification”
        • the types of information your documentation will contain (e.g., the structure of the TOC, are you going to follow minimalism practices?) – “Documentation Content Concept Specification”
        • the functionality and user interface of your documentation suite (e.g., how it will work and how the audience will interact with it) – “Online Help User Interface Concept Specification”, “Printed Documentation User Interface Concept Specification”, etc.
        • the delivery method (how you will deliver the help to users and how you’ll update it)
        • what languages the documentation will be produced in
        Design some possible implementations

        Now that you’ve decided roughly what you’d like to produce, you can design some possible implementations of it. Your designs will be very high level and they may not actually work (they may actually be just paper prototypes).

        With most other considerations already finalised through your user requirements research, these implementations should only differ as a result of:

        • the technologies behind them
        • the tools used to create them
        • the overall look and feel
        You need to learn as much as possible about these things, in order to determine what is actually possible, successful, effective, etc. You should be aware of current trends, literature, white papers, etc. This information can be obtained from a variety of sources. Some good places to start include:

        • List servers
        • Conferences
        • Books
        • Other publications
        • Other writers
        • Other products
        Conduct usability testing on your prototypes

        Model (prototype) your designs for the decision makers and audience samples. This allows you to pick the best features from each design (and to determine priorities for them). Select a design (or merge multiple designs) that you believe best satisfies user requirements. This process may be iterative. At the end of this stage, you should know enough to detail exactly what you’ll be producing (including what help platform and tool you’ll be using).

        TIP: For details on possible research methods, take a look at Managing Your Documentation Projects by Hackos (1994) esp. pp.446-447, User and Task Analysis for Interface Design by Hackos & Redish (1998), Social Marketing: New Imperative for Public Health by Manoff (1985), Designing Qualitative Research 2nd Edition by Marshall & Rossman (1995), and “Conducting Focus Groups – A Guide for First-Time Users”, in Marketing Intelligence and Planning by Tynan & Drayton (1988).

        Write your Requirements Specifications

        Requirements specifications detail exactly what you must end up with. These specifications should contain as much detail as possible about the features and functionality of the documentation product (not how you’ll go about building it).

        Requirements specs are basically an evolution of your concept specs. Once you begin work on your requirements specs, the concept specs are effectively frozen. You should write one or more concept spec(s) for:

        • what components the documentation suite will consist of (online help, printed manuals, tutorials, overviews, etc.) – “Documentation Products Requirements Specification”
        • the types of information your documentation will contain (e.g., the structure of the TOC, are you going to follow minimalism practices?) – “Documentation Content Requirements Specification”
        • the functionality and user interface of your documentation suite (e.g., how it will work and how the audience will interact with it) – “Online Help User Interface Requirements Specification”, “Printed Documentation User Interface Requirements Specification”, etc.
        • the delivery method (how you will deliver the help to users and how you’ll update it)
        • what languages the documentation will be produced in
        Estimate Project Duration & Resources

        Once you’ve completed the requirements spec stage, you should know enough to accurately estimate the duration and resource requirements for the remainder of the project. You should also update the “Documentation Project Plan” document with this information.

        Estimating is always a difficult process, and there’s not really any sure-fire way of getting it right. Mostly it depends on the job and your experience. However, following are some guidelines that might help you.

        If you have records from previous projects, you might simply be able to estimate project duration based on these. You should try to compare the old subject material and topics with the new to make sure that the old times will be applicable to the new project. On p.174 of Managing Your Documentation Projects (1994), Hackos provides some potentially useful guidelines for comparing the complexity of various documentation projects.

        If, on the other hand, the project is entirely new, you will have no records to use as a guide (unless you have managed a similar project in the past). In this situation, project estimates will be very difficult to make.

        One possible method for estimating is:

        1. Compile a list of tasks, and record how many there are in your list.
        2. Compile a list of concepts that must be documented, and record how many there are in your list.
        3. From your list of tasks, select 10 that are representative of the rest (in terms of complexity, expected length, status of the relevant development, etc.), and of the same granularity (e.g., you can write a single topic for each).
        4. From your list of concepts, select 3 that are representative of the rest, and of the same granularity (e.g., you can write a single topic for each).
        5. Internet Marketing Guide - 5 Steps To Succeed In Internet Marketing
          Whether you have an online site, an online business, or a land based business, you would want it to be successful. You would want people and possible purchasers to be directed to you. And you would want your income to keep on coming.If you want this for your site or for your business, you can turn to an Internet marketing guide. When you choose to market your business over the Internet, you will be greatly benefited. With the advancement of the computer, allowing people to obtain the information that they need with just a click of the mouse, more have turned to it. When you develop online marketing strategies, you will be able to direct the people to your business.If you want an effective Internet marketing guide, do not just opt to submit your URL to various search engines. This method is not enough to bring a stream of traffic to your site. If you do not want to end up in the twentieth page of search engine results, then you have to do more than just sitting back and relaxing. With the following steps to successful Internet marketing, you might just rank within the first page of search engine results.- Make the content of your site up to date and informative: If you make sure of this, visitors will keep on viewing your site, returning every time they need something. Useful information should relate to what you have to offer. Do not make it too long, or the people will lose their interest. You can use bullets and short paragraphs to get your point across easily. You should remember that t
          y be just paper prototypes).

          With most other considerations already finalised through your user requirements research, these implementations should only differ as a result of:

          • the technologies behind them
          • the tools used to create them
          • the overall look and feel
          You need to learn as much as possible about these things, in order to determine what is actually possible, successful, effective, etc. You should be aware of current trends, literature, white papers, etc. This information can be obtained from a variety of sources. Some good places to start include:

          • List servers
          • Conferences
          • Books
          • Other publications
          • Other writers
          • Other products
          Conduct usability testing on your prototypes

          Model (prototype) your designs for the decision makers and audience samples. This allows you to pick the best features from each design (and to determine priorities for them). Select a design (or merge multiple designs) that you believe best satisfies user requirements. This process may be iterative. At the end of this stage, you should know enough to detail exactly what you’ll be producing (including what help platform and tool you’ll be using).

          TIP: For details on possible research methods, take a look at Managing Your Documentation Projects by Hackos (1994) esp. pp.446-447, User and Task Analysis for Interface Design by Hackos & Redish (1998), Social Marketing: New Imperative for Public Health by Manoff (1985), Designing Qualitative Research 2nd Edition by Marshall & Rossman (1995), and “Conducting Focus Groups – A Guide for First-Time Users”, in Marketing Intelligence and Planning by Tynan & Drayton (1988).

          Write your Requirements Specifications

          Requirements specifications detail exactly what you must end up with. These specifications should contain as much detail as possible about the features and functionality of the documentation product (not how you’ll go about building it).

          Requirements specs are basically an evolution of your concept specs. Once you begin work on your requirements specs, the concept specs are effectively frozen. You should write one or more concept spec(s) for:

          • what components the documentation suite will consist of (online help, printed manuals, tutorials, overviews, etc.) – “Documentation Products Requirements Specification”
          • the types of information your documentation will contain (e.g., the structure of the TOC, are you going to follow minimalism practices?) – “Documentation Content Requirements Specification”
          • the functionality and user interface of your documentation suite (e.g., how it will work and how the audience will interact with it) – “Online Help User Interface Requirements Specification”, “Printed Documentation User Interface Requirements Specification”, etc.
          • the delivery method (how you will deliver the help to users and how you’ll update it)
          • what languages the documentation will be produced in
          Estimate Project Duration & Resources

          Once you’ve completed the requirements spec stage, you should know enough to accurately estimate the duration and resource requirements for the remainder of the project. You should also update the “Documentation Project Plan” document with this information.

          Estimating is always a difficult process, and there’s not really any sure-fire way of getting it right. Mostly it depends on the job and your experience. However, following are some guidelines that might help you.

          If you have records from previous projects, you might simply be able to estimate project duration based on these. You should try to compare the old subject material and topics with the new to make sure that the old times will be applicable to the new project. On p.174 of Managing Your Documentation Projects (1994), Hackos provides some potentially useful guidelines for comparing the complexity of various documentation projects.

          If, on the other hand, the project is entirely new, you will have no records to use as a guide (unless you have managed a similar project in the past). In this situation, project estimates will be very difficult to make.

          One possible method for estimating is:

          1. Compile a list of tasks, and record how many there are in your list.
          2. Compile a list of concepts that must be documented, and record how many there are in your list.
          3. From your list of tasks, select 10 that are representative of the rest (in terms of complexity, expected length, status of the relevant development, etc.), and of the same granularity (e.g., you can write a single topic for each).
          4. From your list of concepts, select 3 that are representative of the rest, and of the same granularity (e.g., you can write a single topic for each).
          5. Maryland Mortgage Lenders
            There are hundreds of mortgage lending companies in Maryland. Most of them offer hundreds of different kinds of mortgage loans with competitive rates to attract the booming market. It is very important to locate a good credible company -- a company that gives you the best policy at the best price. Ideally, there are brokerage companies who act as agents between the borrowers and the lenders. The brokerage companies help customers compare and seek out the best offers from multiple companies that can otherwise be very difficult. Since these companies work with multiple lending companies, they can help any borrower-- even those with bad credit records.The main aspects to consider when taking out a mortgage are: what is the rate of interest, what would be the monthly payments, what is the kind of loan (fixed vs. variable), is it ideal under the present market conditions, what are the fees and are there any hidden costs? Almost all companies have almost similar offers. But some companies may offer better rates based on your credit rating. There are companies that claim to provide customized mortgage loans for people with bad credit records, for first-time homebuyers, and for self-employed people. They also help with mortgage refinancing, second mortgages and debt consolidation.The yellow pages, the Internet, newspapers, friends and family members are some of the sources for finding a Maryland mortgage company. These companies also have their own websites with detailed information. The kinds of loans, rates a
            95), and “Conducting Focus Groups – A Guide for First-Time Users”, in Marketing Intelligence and Planning by Tynan & Drayton (1988).

            Write your Requirements Specifications

            Requirements specifications detail exactly what you must end up with. These specifications should contain as much detail as possible about the features and functionality of the documentation product (not how you’ll go about building it).

            Requirements specs are basically an evolution of your concept specs. Once you begin work on your requirements specs, the concept specs are effectively frozen. You should write one or more concept spec(s) for:

            • what components the documentation suite will consist of (online help, printed manuals, tutorials, overviews, etc.) – “Documentation Products Requirements Specification”
            • the types of information your documentation will contain (e.g., the structure of the TOC, are you going to follow minimalism practices?) – “Documentation Content Requirements Specification”
            • the functionality and user interface of your documentation suite (e.g., how it will work and how the audience will interact with it) – “Online Help User Interface Requirements Specification”, “Printed Documentation User Interface Requirements Specification”, etc.
            • the delivery method (how you will deliver the help to users and how you’ll update it)
            • what languages the documentation will be produced in
            Estimate Project Duration & Resources

            Once you’ve completed the requirements spec stage, you should know enough to accurately estimate the duration and resource requirements for the remainder of the project. You should also update the “Documentation Project Plan” document with this information.

            Estimating is always a difficult process, and there’s not really any sure-fire way of getting it right. Mostly it depends on the job and your experience. However, following are some guidelines that might help you.

            If you have records from previous projects, you might simply be able to estimate project duration based on these. You should try to compare the old subject material and topics with the new to make sure that the old times will be applicable to the new project. On p.174 of Managing Your Documentation Projects (1994), Hackos provides some potentially useful guidelines for comparing the complexity of various documentation projects.

            If, on the other hand, the project is entirely new, you will have no records to use as a guide (unless you have managed a similar project in the past). In this situation, project estimates will be very difficult to make.

            One possible method for estimating is:

            1. Compile a list of tasks, and record how many there are in your list.
            2. Compile a list of concepts that must be documented, and record how many there are in your list.
            3. From your list of tasks, select 10 that are representative of the rest (in terms of complexity, expected length, status of the relevant development, etc.), and of the same granularity (e.g., you can write a single topic for each).
            4. From your list of concepts, select 3 that are representative of the rest, and of the same granularity (e.g., you can write a single topic for each).
            5. A Means to an End
              One of the most stressful moments for most sales people comes at the point when they have to decide whether or not to go around someone they have been dealing with to that point, be they client or prospect.Some call it end run, backdoor, go over someone’s head, run around, what ever you call it, it’s never an easy decision, and certainly not always the right tactic; having said that it is more often the right choice than most sales people believe.There are a number of factors in determining if and when to do an end run in order to win a deal. The value of the product/solution to the client organization; how pervasive is your solution in the client’s organization; how the client goes about purchasing both in terms of deciding and executing the purchase. And most notably, how good the rep is to begin with.Assumably, top notch sellers will not get pigeon holed in a way that will force them to make that decision, but experience has shown that when they have to, they tend to go for it and usually win.At the same time reps who sell solutions that rightly or wrongly have traditionally had lower perceived value or commoditized products/services such as packaging, office supplies, print services, copiers and office equipment, promotional items, industrial supply, and others, are the most reluctant to do an end run. These are the very reps that should be expanding their sales beyond their traditional buyers. The same reps who usually confuse users (the wholly grail end user) with real decision maker
              ents for the remainder of the project. You should also update the “Documentation Project Plan” document with this information.

              Estimating is always a difficult process, and there’s not really any sure-fire way of getting it right. Mostly it depends on the job and your experience. However, following are some guidelines that might help you.

              If you have records from previous projects, you might simply be able to estimate project duration based on these. You should try to compare the old subject material and topics with the new to make sure that the old times will be applicable to the new project. On p.174 of Managing Your Documentation Projects (1994), Hackos provides some potentially useful guidelines for comparing the complexity of various documentation projects.

              If, on the other hand, the project is entirely new, you will have no records to use as a guide (unless you have managed a similar project in the past). In this situation, project estimates will be very difficult to make.

              One possible method for estimating is:

              1. Compile a list of tasks, and record how many there are in your list.
              2. Compile a list of concepts that must be documented, and record how many there are in your list.
              3. From your list of tasks, select 10 that are representative of the rest (in terms of complexity, expected length, status of the relevant development, etc.), and of the same granularity (e.g., you can write a single topic for each).
              4. From your list of concepts, select 3 that are representative of the rest, and of the same granularity (e.g., you can write a single topic for each).
              5. Estimate the number of pages per topic.
              6. Document these tasks and concepts as a trial, ensuring that you track:

                • the total time taken to complete each topic.
                • the portion of this time that was due to product change or indecision.
                • the number of pages per topic.
                • the number of extra, unexpected, but necessary, topics you became aware of as a result of the documentation. Keep a separate record of the number for both task and conceptual topics.

                TIP: Make the most of your trial doco. Even though you’ve chosen a design through design prototyping, you can use your documentation sample to test the usability of your documentation approach. By presenting the sample to an audience sample, you can determine whether you’re heading in the right direction with your doco (i.e. whether you have interpreted and implemented your user research results correctly).

              7. Determine the average time taken per page for task and for conceptual topics.
              8. Apply this average to the rest of the topics in the project. (Topics written early in the project normally take longer due to lack of information and a higher number of technical issues. This means topics written later in the process will probably take less than the average calculated here. However, this will normally be offset by the extra time product changes will incur during the project life-cycle.)
              9. Estimate the time per subject area based on the average time per topic.
              10. Estimate the number of extra, unexpected, topics that will likely become necessary during the course of the rest of the project.
              11. Allow for training, work prac maintenance, holidays, sick days, meetings, usability testing, production (approx 6 weeks turnaround time for printing a 1000 page manual, including proofing), evaluation, and evaluative testing. Each of these elements will vary according to the nature of the project, and they will tend to take far less time than the actual writing. That is why specific guidelines are not provided as they are for writing.
              Figure out how long you actually have to do it, then how many writers you’ll need to get it done during this time. Draw up a project schedule using something like Microsoft Project, identifying useful milestones and project deadlines. Some of your milestones might include:

              • Prototype Testing Complete
              • Work Pracs Written
              • Design Specs Written
              • First Draft Complete
              • Second Draft Complete
              • Localisation of Second Draft Complete
              • Final Draft Complete
              • Localisation Complete
              • Documentation Ready for Release
              • Production Complete
              • Project Evaluation Complete
              • Post-release Usability Testing Complete
              It is important to note that you will have milestones before this point, but because they occur prior to the formal scheduling stage, they don’t need to be included in this schedule.

              Write Work Pracs & Design Specs

              Along with user research, work pracs and design specs are perhaps the easiest project elements to overlook, especially for a small team. However, even within small teams, it is helpful to maintain both.

              Work pracs are for ongoing things, that affect the day to day working environment of the team (e.g., How to use your documentation tool, How to release your help, a style guide, etc.). Design specs are for documenting one-off things like how we actually plan to go about this thing. This will include such information as what tools we’ll be using, what each will do, and the mechanics of how it all fits together. e.g., How the VSS project will work, how everything should be managed, multi-user issues, how it will be localised, etc.

              To be continued… See part 3 of this article (http://www.divinewrite.com/docoprocess3.htm) for information on writing your user documentation.

    HTTP = HTML link (for blogs, profiles,phorums):
    <a href="http://www.atriclecheck.com/article/158530/atriclecheck-Successful-Documentation-Projects--Part-2-of-3--Specifying.html">Successful Documentation Projects - Part 2 of 3 - 'Specifying'</a>

    BB link (for phorums):
    [url=http://www.atriclecheck.com/article/158530/atriclecheck-Successful-Documentation-Projects--Part-2-of-3--Specifying.html]Successful Documentation Projects - Part 2 of 3 - 'Specifying'[/url]

    Related Articles:

    Sales Tips From Man's Best Friend

    Easy Ways To Eliminate Credit Card Debt

    At Home Sale Business Opportunities Abound

    Bookmark it: del.icio.us digg.com reddit.com netvouz.com google.com yahoo.com technorati.com furl.net bloglines.com socialdust.com ma.gnolia.com newsvine.com slashdot.org simpy.com shadows.com blinklist.com