Scribd Logo
Upload

Welcome to Scribd!

  • 2 views

    1.1.8_to_1.1.10_-User_Focus

    Uploaded by

    Sahaj Khurana

    Copyright:

    © All Rights Reserved
    Download as PPTX, PDF, TXT or read online from Scribd

    1.1.8_to_1.1.10_-User_Focus

    Uploaded by

    Sahaj Khurana
    2 views7 pages

    Copyright

    © © All Rights Reserved

    Available Formats

    PPTX, PDF, TXT or read online from Scribd

    Did you find this document useful?

    Is this content inappropriate?

    Copyright:

    © All Rights Reserved
    Download as PPTX, PDF, TXT or read online from Scribd
    Download as pptx, pdf, or txt
    2 views7 pages

    1.1.8_to_1.1.10_-User_Focus

    Uploaded by

    Sahaj Khurana

    Copyright:

    © All Rights Reserved
    Download as PPTX, PDF, TXT or read online from Scribd
    Download as pptx, pdf, or txt
    of 7

    User Focus

    1.1.8 TO 1.110
    The importance of user
    documentation
     As programs become more complex and
    detailed the users way of thinking may differ
    from the developers.
     This may lead to serious problems during the
    implementation or operational stage of the
    Software Life Cycle (SLC).
     The user might not know how to use the
    product to its full capacity, and even specialized
    technicians may not be able to set up the new
    system properly for the firm they work for.
     This is where there is a need for an effective
    and detailed instruction manual highlighting all
    components of the program.
    The importance of user documentation - Internal
     At this stage it is important to determine the difference between internal and external documentation
     Internal documentation is the code comprehension features and details provided as part of the source code
    itself. Proper internal documentation includes:
     Appropriate module headers
     Appropriate comments
     Useful and meaningful variable names
     Useful module, classes, methods and function headers
     Appropriate code indentation
     Appropriate code structuring
     Appropriate use of enumerated types
     Appropriate use of constant identifiers
     Appropriate use of data types defined by the user
    It is very difficult and likely to be
    impossible for the source code
    to be read by the final user.
    The importance of user
    documentation - External
     External documentation is typically written
    as a separate document from the program
    itself.
     It is provided through various types of user
    supporting documents such as a users' guides,
    software requirements specification, detailed
    description of the design and implementation
    features of the program and test document.
    Different
    methods of User documentation can The user documentation The document should be

    providing user either be in a written or


    in an online form,
    should include all the
    instructions that are
    mandatory for the
    well structured and
    divided into the
    appropriate categories.
    documentation system to operate and
    should contain frequently
    asked questions, which
    are always necessary for
    new users.
     Manuals – Whether it be a hard copy or
    something like a .pdf document
     Email Support – Email any issues and
    they can reply
     Embedded Assistance or integrated
    Different user assistance – When you are
    working on something and a box pops up
    methods of to give instructions or tips
    providing user  Classroom based training – As the
    documentation name suggests. Sitting in a classroom
    either hands on or watching some else
     Online based training – An online
    course where users can study 24/7 365
    days a year.
    Frequently Asked Live chat sessions- Acts
    Questions – Usually a page like chat software and
    Different where the most common
    questions are answered
    usually via text where the
    user and support can discuss
    the problem and a solution
    methods of
    providing user
    documentation

    Online portals or web Remote Desktop


    portals- These can contain Connections – Someone is
    updated manuals and a able to log into your
    support forum where people computer and solve the
    can discuss and help each issue for you
    other

    You might also like