?
Solved

Doc'in system (example?) BA

Posted on 2016-07-29
7
Medium Priority
?
140 Views
Last Modified: 2016-07-31
Hello ,

A new system is been built. I am supposed to doc what the system will do, step by step. Can you guys give me links of an exact documentation of how the new built system will behave in steps? like an example out there in web , can give me a template idea of how i should write it up. In addition, any other tools I should use while documenting it, besides MS Word, like visually if any
thank you
0
Comment
Question by:Rayne
[X]
Welcome to Experts Exchange

Add your voice to the tech community where 5M+ people just like you are talking about what matters.

  • Help others & share knowledge
  • Earn cash & points
  • Learn & ask questions
  • 4
  • 3
7 Comments
 
LVL 33

Expert Comment

by:Paul Sauvé
ID: 41734763
>>I am supposed to doc what the system will do, step by step

Is this 'system' an application?

Is there any existing documentation that was written during the development process (for example, requirements documentation)? If so, that would be a good place to start.

  • Document how the new system meets the initial requirements

  • Create end-user guides

0
 
LVL 33

Expert Comment

by:Paul Sauvé
ID: 41734778
here is some additional information: scroll down to How to write cost-effective documentation for your software system

here is a tutorial with templates: User Guide Tutorial
0
 

Author Comment

by:Rayne
ID: 41736609
Paul
this is a new application that will interact with user. is there a sample example in web for a real system?
0
Technology Partners: We Want Your Opinion!

We value your feedback.

Take our survey and automatically be enter to win anyone of the following:
Yeti Cooler, Amazon eGift Card, and Movie eGift Card!

 

Author Comment

by:Rayne
ID: 41736610
example of dcumentation
0
 
LVL 33

Assisted Solution

by:Paul Sauvé
Paul Sauvé earned 2000 total points
ID: 41736622
>> A new system is been built

Since the description of your 'system' is so vague, I can only refer you to the generic examples above... (User Guide Tutorial)
0
 
LVL 33

Accepted Solution

by:
Paul Sauvé earned 2000 total points
ID: 41736626
Here is a link to Paint.NET user guide that may inspire you: Paint.NET documentation

Note that there is detailed documentation on the following subjects (top menu):

    Getting Started
    User Interface
    Menus
    Tools
    Layers
    Color
    History
0
 

Author Closing Comment

by:Rayne
ID: 41736727
Thank you Paul
0

Featured Post

Survive A High-Traffic Event with Percona

Your application or website rely on your database to deliver information about products and services to your customers. You can’t afford to have your database lose performance, lose availability or become unresponsive – even for just a few minutes.

Question has a verified solution.

If you are experiencing a similar issue, please ask a related question

Make the most of your online learning experience.
What do responsible coders do? They don't take detrimental shortcuts. They do take reasonable security precautions, create important automation, implement sufficient logging, fix things they break, and care about users.
In this fourth video of the Xpdf series, we discuss and demonstrate the PDFinfo utility, which retrieves the contents of a PDF's Info Dictionary, as well as some other information, including the page count. We show how to isolate the page count in a…
Six Sigma Control Plans

718 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question