Templete by anasraiden

VIEWS: 9 PAGES: 4

									                                    Documentation Template
Writing Standards
      Paper Size: A4
      Orientation: Portrait
      Top Margin: 1 inch
      Left Margin: 1 inch
      Right Margin: 0.7 inch
      Bottom Margin: 0.5 inch
      Document Font: Arial
      Main Heading Font: Arial
      Main Heading Font Style: Bold
      Main Heading Font Size: 14
      Sub Heading Font: Arial
      Sub Heading Font Style: Bold
      Sub Heading Font Size: 12
      Normal Text Font: Arial
      Normal Text Font Style: Regular
      Normal Text Font Size: 12
      Headers & Footers as in this template.
      Every form and report documentation will start from a new page.




Flow Chart
The whole module form level flow is to make. Use the below mentioned shapes:




                                                      Start / Stop shape
   Process shape



                                                       On Page Connector shape


    Decision shape


                                                         Off Page Connector shape




                                                          Flow Indicator
   Input / Output shape




SigmaTec Unify - Documentation                                                      Page 1
                                         Forms Documentation Template

Menu Name                        -                             Form Name                      -
Purpose                   -


User Interfaces:
              User Interface as in the system.
              If there are multiple instances if screen shots are for processing, than attached all screen shots.

Fields:

Sr. #     Name                Nature     Type          Dependency         Dependant        Fetched       Purpose /
                                                                          on field         from          Functions/
                                                                                                         Formula
          Actual name         M/O        Numeric       Yes / NO           Name of the      If the        Descried the
          of the field                   / Alpha                          field on         value is      purpose of
                                         Numeric                          which the        fetched       the field and
                                         / Alpha                          field is         from any      if formula is
                                                                          dependant        other         applied
                                                                                           form then     there than
                                                                                           mention       write the
                                                                                           the form      formula as
                                                                                           name          well.
                                                                                           here

Processing Case:
    Step by step form processing should be written here.
    The steps should in an order.
    Write the steps with a best case test scenario.

Voucher:
    If there is any voucher from this form posted in the system. Write the actual voucher stating
      the control heads.

Next form to Process:
Form Name
Name of the forms which will be the next one.

Next Available on:
Form Name                                                      For the purpose of
Name of the forms on which the form data is                    State the purpose of availability
available

Related Reports:
Reports Names
Write the related reports name


SigmaTec Unify - Documentation                                                                                           Page 2
                                    Reports Documentation Template

Menu Name                   -                            Report Name                   -
Purpose               -


Screen Shot (Calling Form):
          Calling form as in the system.




Screen Shot (Report Layout -1):
              Report layout screen shot with data as in the system.




Report Layout 1 – Heads:
Sr.#   Report Head                                                     Data Fetched From
       The report layout field name will be written here               State the form from where the data is
                                                                       fetched and shown.
                                                                       If the data is manipulated on the
                                                                       report, write the formula here.


Screen Shot (Report Layout -2….n):
              Report layout screen shot with data as in the system.




Report Layout 2…n – Heads:
Sr.#   Report Head                                                     Data Fetched From
       The report layout field name will be written here               State the form from where the data is
                                                                       fetched and shown.
                                                                       If the data is manipulated on the
                                                                       report, write the formula here.




SigmaTec Unify - Documentation                                                                             Page 3
Buttons Legends
Following is the buttons Legend which can be used as it is in any where of the documentation.


                     This icon is used to save the record.
                     After saving a particular record, user can generate a new record as and when
                      required.
                     This icon is used to cancel/refresh/undo the changes.


                     This icon is used to close the form.


                     This icon is used to preview the records to print.


                     If this box is checked and the record was saved earlier, then this record
                      cannot be edited further and it will not be available for any change.




SigmaTec Unify - Documentation                                                                  Page 4

								
To top