Documents and interfaces for detailed description

Description of document

When describing any document it should have at least the following pages – General Description, Create, Edit, Add/Edit Line, File. All of them should be located in the following sample structure:

  • Module
    • Description, documents and operations
      • Document (general description)
        • Create
        • Editorial
        • Add a row
        • File

Documents that should have a similar description:

  • For Sale
  • Storing a sale
  • Replace
  • Order
  • Order cancellation
  • Revenue invoice
  • Invoice credit for revenue
  • Invoice for expense
  • Credit against invoice for expense
  • Revision
  • PCP/PCO
  • Credit/Debit

Everyone else can get by with the general description from System Description > Document File and System Description > Documents and Objects. Back to

 

Interface description in Module Operations

Usually these are filter and result lists. Describes how the fitter works. Describes what the result shows. If the result is in more than one tab each tab is described. If there are action options in the result, describe what actions can be done with the result and reference the relevant help pages (most likely located somewhere in Module >Description, documents and operations) If the result contains links to document/object files, describe what related information can be accessed from it.

Interfaces that should have a similar description:

  • Sales/invoicing/payment/discharge
  • Orders/invoicing
  • Revenue
  • Costs
  • Payments
  • Pending operations
  • Loading of stock
  • Charging the company
  • Service Requests
  • Quantities requested

All others can pass with the general description from the System Description > Lists. Back to
Редакция