Want to protect your cyber security and still get fast solutions? Ask a secure question today.Go Premium

x
  • Status: Solved
  • Priority: Medium
  • Security: Public
  • Views: 151
  • Last Modified:

Doc'in system (example?) BA

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
Rayne
Asked:
Rayne
  • 4
  • 3
2 Solutions
 
Paul SauvéRetiredCommented:
>>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
 
Paul SauvéRetiredCommented:
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
 
RayneAuthor Commented:
Paul
this is a new application that will interact with user. is there a sample example in web for a real system?
0
Concerto Cloud for Software Providers & ISVs

Can Concerto Cloud Services help you focus on evolving your application offerings, while delivering the best cloud experience to your customers? From DevOps to revenue models and customer support, the answer is yes!

Learn how Concerto can help you.

 
RayneAuthor Commented:
example of dcumentation
0
 
Paul SauvéRetiredCommented:
>> 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
 
Paul SauvéRetiredCommented:
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
 
RayneAuthor Commented:
Thank you Paul
0

Featured Post

VIDEO: THE CONCERTO CLOUD FOR HEALTHCARE

Modern healthcare requires a modern cloud. View this brief video to understand how the Concerto Cloud for Healthcare can help your organization.

  • 4
  • 3
Tackle projects and never again get stuck behind a technical roadblock.
Join Now