DataMuseum.dk

Presents historical artifacts from the history of:

CR80 Wang WCS documentation floppies

This is an automatic "excavation" of a thematic subset of
artifacts from Datamuseum.dk's BitArchive.

See our Wiki for more about CR80 Wang WCS documentation floppies

Excavated with: AutoArchaeologist - Free & Open Source Software.


top - download

⟦30414c438⟧ Wang Wps File

    Length: 13295 (0x33ef)
    Types: Wang Wps File
    Notes: Spelunked
    Names: »~ORPHAN70.00«

Derivation

└─⟦84647c47a⟧ Bits:30005817 8" Wang WCS floppy, CR 0014A
    └─ ⟦this⟧ »~ORPHAN70.00« 

WangText



F   E…09…E…86…1
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
    …02… 
     
     
     
     
     …02…
     
    …02… 
     
     
     
     
    

…02…SD/STD/008

    SVO/800814…02……02…B-#
SOFTWARE
 DOCUMENTATION
 STANDARD
    DRAFT GENERAL







                        APPENDIX B

                   HIPO CHARTS STANDARD

                             



B.1      G̲E̲N̲E̲R̲A̲L̲ ̲F̲O̲R̲M̲A̲T̲

         -   The HIPO Worksheet should be used.

         -   Input/output diagrams limited to one page are more
             readable than multiple-page diagrams. If multiple
             page diagrams areused, the process steps should
             be numbered sequentially throughout the diagram.

         -   Each diagram should contain certain information
             for identification. The HIPO Worksheet provides
             a heading for the following information:

             -   The name of the proces being documented

             -   The number of the document in which the diagram
                 is appearing

             -   The issue number of the document

             -   The diagram identification (which should correspond
                 to the one used in the overview chart)

             -   The diagram revision numbr (consecutive numbering)

             -   The date

             -   The page number in the document.




B.2      D̲A̲T̲A̲ ̲I̲T̲E̲M̲S̲ ̲A̲N̲D̲ ̲D̲A̲T̲A̲ ̲G̲R̲O̲U̲P̲S̲

         a)  The following are examples of data items that may
             be shown within the input or output section of
             an input/output diagram. The item may be labeled.
             Note that the size of a data item box has no functional
             significance; it is determined by the amount of
             information to be placed in that box.


             Example 1









             A single data item symbol. This may be a field,
             register, record, storage area, etc. The label
             identifies the item and should be the name actually
             used in th program if one has been assigned. If
             this is the case, it should be in capital letters.
             The text can briefly describe the data item. The
             extended description section may identify important
             attributes.

             Example 2






             A record with a layout offields within it, shown
             several to a line.










             A record with a layout of fields within it, shown
             one to a line. This format can facilitate drawing
             the arrows and updating the data item.

             Example 3





             A flag block. A data item that has a lenght of
             one or more bytes. Each of the 8 bits within each
             byte may be tested or modified. The significant
             bits should be shown as a 1 or 0.The remaining
             bits should be shown as periods. If a bit may be
             significant but may be 0 or 1, an X may be used.

             Preferably, the layout of a flag block is shown
             in the extended description or a separate figure
             to permit easier updating, should th contents change.

             Example 4













             External devices. The standard flowchart symbols
             may be used to depict external media such as cards,
             documents, tape, online storage, and display devices.
             When physical device dependency is not importan
             or does not exist, a data item symbol should be
             used.

         b)  A data group is one or more of the data items discussed
             above which are enclosed in a box. The purpose
             of grouping data items is to indicate that all
             of the items within the box are includd in the
             data flow of arrows that touch the edge of this
             box. The value of placing data items within a data
             group is to reduce the number of arrows. For example:…86…1
                     …02…   …02…   …02…   …02…                             
               …02…          
























         c)  Only the fields used should be shown in the input.
             A space left before or after a field in a data
             item implies that the item contains other fields
             not rlevant to this input. A space does not necessarily
             indicate how many fields have been omitted or their
             lengths. Also, the ordering of fields within a
             data item does not necessarily imply the actual
             order in the record, table, etc. (unless it is
             a pogram dependency, in which case it must be so
             stated in the extended description). It is often
             useful to rearrange fields or groups of data items
             to facilitate a better layout of data related to
             process steps and avoid the crossing of data movementand
             data reference arrows.



B.3      A̲R̲R̲O̲W̲S̲

         a)  Arrows are used to indicate either the movement/manipulation
             of data, or data references/pointers.

         b)  The flow of control is not indicated by arrows
             but is alone shown in associated flowgrams.


         c)  The width of the arrow does not depict a function
             difference. A wide arrow of a given arrow type
             may be used for emphasis; two sizes of arrows are
             shown on the HIPO template. Wile the narrow arrow
             is the one most frequently used, the wide arrow
             may be used when there is only one arrow in the
             input and output paths. Any other use of different-width
             arrows should be explained in the legend and extended
             descriptions, as appopriate. If required, arrows
             may join each other or may cross over each other,
             as described later in this section.

         d)  The data movement arrow indicates which data item
             or group of data items is moved or manipulated,
             or produced or modified, by th associated process
             step(s).
























         e)  The data pointer arrow indicates the address of
             another data item






             The arrow may connect the data items:









         f)  A data arrow in the input path should begin at
             the right-hand e̲d̲g̲e̲ of a data item or data group,
             and terminate at the number ofthe process step
             that uses this item(s). For output it should begin
             at the right-hand edge of the text for the process
             step, and terminate at the left-hand edge of a
             data item or data group in the output section.
             The beginning of all output arrows ay be aligned.
             The exception to this is, that arrows may be drawn
             in such a manner as to prevent crossing text with
             an arrow.


             See example on the next page.…86…1         …02…   …02…   …02… 
              …02…                                …02…          



































             It is unclear in the first example whether the
             input was FLDA or all data, or whether the input
             was for step 1 or 2.


         g)  Arrows should be as straight as possible so the
             eye can easily follow them. For example…86…1      
               …02…   …02…   …02…   …02…                                …02…   
                   
         h)  If there is only one data movement arrow in a given
             diagram, it may go from the edge of the entire
             input section to the edge of the entire process
             section, and from the edge ofthe entire process
             section to the edge of the entire output section.
             Frequently, a wide arrow is used for emphasis here.
             This is particularly useful for overview diagrams.


         i)  Arrows may cross over each other or may join to
             show that they point to the same process step number.
             Crossing arrows should be kept to a minimum. Many
             times they can be avoide by rearranging the data
             items, enclosing data items within a box (data
             group), leaving space between process steps, or
             using keyed data arrows (see below). The following
             example shows crossing arrows.


             From the above, a user can tell that the arrow
             to step 1 is from FLDA and FLDC, and that the arrow
             to step 2 crosses the other arrow and is from data
             FLDB.

         j)  It is more difficlt to illustrate crossing arrows
             with data reference arrows.…86…1         …02…   …02…   …02…   …02…
                                            …02…          
             In the above example, FLDC may go to both steps
             1 and 2. In order to clarify that the arrow from
             FLDC goes to step 2, and the arrows from FLDA and
             FLDC go to step l, the followin technique is suggested.
             When an arrow merges with another arrow, the merging
             arrow should terminate with an arrowhead; if it
             crosses another arrow, there should not be an arrowhead
             at the intersection.





















         k)  Data movement or dat reference arrows should not
             point from the process steps to the input area.

         l)  Keyed data arrows are associated by means of the
             same letter and are of the form:


         The letters may be circled or boxed. Keyed data arrows
         are used when multiple arrows in the input and output
         paths would be confusing to the user. Their use should
         be kept to a miimum.

         m)  When data is used repeatedly, the following may
             be done:

             (1) If a data item is input to several steps, but
                 not output from them, the following alternatives
                 are given:

                 a)  Use a single arrow from the data to the
                     steps (which for thi approach be consecutive
                     and grouped by boxing)

                 b)  Use a multiple arrow (one tail, several
                     heads) from the data to each step.

                 c)  Use a keyed data arrow.

                 These approaches may be combined.…86…1        
                 …02…   …02…   …02…   …02…                                …02… 
                         
             (2) If a data item is output from one step and
                 then becomes input to a later step(s):

                 a)  Use a single or multiple arrow back from
                     the output data to the later step(s), using
                      keyed data arrow if necessary.

                 b)  Repeat the data on the input side. In this
                     case the reader must be told that the data
                     item is not original input, by adding text
                     (e.g. "created in step 3" or "from step
                     3") to the data on the input side.

             Th first option should be used except where it
             would cause confusion of arrows in the output path.…86…1
                     …02…   …02…   …02…   …02…                             
               …02…          
             (3) If a data item is input to a step that modifies
                 it, and then is input (in its modified form)
                 to a later step(s), the same techniques as
                 in (2) above may be used, but the word"updated"
                 rather than "created" should be used. Note
                 that the use of the words "created" and "updated"
                 with output data items may be helpful even
                 when they are not used as input later.




























         n)  When data shown in the output aea is used as both
             input and output in the same process step, a double-headed
             arrow may be used.…86…1         …02…   …02…   …02…   …02…         
                                   …02…          
B.4      P̲R̲O̲C̲E̲S̲S̲ ̲S̲E̲C̲T̲I̲O̲N̲

         a)  This section should contain a single column of
             process steps. The steps should be sequentially
             numbered, beginning with 1 as the number of the
             first step o the first page of an input/output
             diagram. Substeps should be lettered sequentially.

         b)  There is no maximum to the number of steps per
             diagram; however, when the number is above the
             range of 7 to 10, the user has more difficulty
             comprehending th material quickly. Putting too
             many steps or too much detail in the process section
             is often the cause of a problem. The problem may
             be corrected by putting some of the information
             in the extended description section or by subdividing
             the functionsinto lower-level input/output diagrams.

         c)  To indicate that a process step is described in
             further detail in another diagram a box should
             be drawn around the process step, and the identification
             number of the lower-level diagram should be placed
             n the lower right-hand corner of the box.

         d)  The content of the process steps varies by development
             stage, complexity of the process, and intended
             audience. In general it is best to begin the process
             statement with the imperative form of a verb, uch
             as:…86…1         …02…   …02…   …02…   …02…                        
                    …02…          

accept    delete       get          perform      select

add       dequeue      handle       place        set

allocate  detach       identify     position     simulate

altr      determine    increment    post         specify

analyze   display      initialize   process      start

assign    do until     insert       provide      stop

begin     do while     issue        purge        store

build     edit         locate       put          supply

calculate encode       link         queue        suspend

check     enqueue      load         read         switch

lear      enter        look up      record       terminate

close     establish    maintain     reinstate    test

complete  examine      make         release      transfer

construct execute      merge        resolve      translate

control   exit         modify       restore      update

convert   extract      monitor      return       use

copy      find         move         can          validate

create    fix          obtain       schedule     verify

decrement format       open         search       write

         e)  T̲h̲e̲ ̲c̲o̲n̲t̲e̲n̲t̲ ̲o̲f̲ ̲t̲h̲e̲ ̲p̲r̲o̲c̲e̲s̲s̲ ̲s̲e̲c̲t̲i̲o̲n̲ ̲s̲h̲o̲u̲l̲d̲ ̲s̲h̲o̲w̲
             ̲f̲u̲n̲c̲t̲i̲o̲n̲ ̲r̲a̲t̲h̲e̲r̲ ̲t̲h̲a̲n̲ ̲c̲o̲d̲e̲ ̲s̲t̲a̲t̲e̲m̲e̲n̲t̲s̲, for example,
             what the loop, branch, or condition test is intended
             to accomplish.

         f)  No deision symbols should be contained within the
             input/output diagram.

         g)  Process steps may contain a subroutine function.
             The subroutine block is shown as follows:









             where the label is the name of the subroutine,
             and NN is the identificatio number of another input/output
             diagram, describing this function.…86…1         …02…  
             …02…   …02…   …02…                                        
               
             The subroutine may be internal to the process described
             or be an external routine. The subroutine should
             be shown as follows:…86…1         …02…   …02…   …02…   …02…       
                                                
         h)  Interactive functions may be shown by enclosing
             these functions within a box, for example:
























         i)  There is a practical limit to the levels of nesting
             that an be seen easily on an input/output diagram.
             If more than two levels are needed, the innermost
             nested items can be shown in a lower-level input/output
             diagram, or referenced in the extended description.

             N̲o̲t̲e̲ ̲t̲h̲a̲t̲ ̲t̲h̲e̲ ̲i̲n̲t̲e̲n̲t̲ ̲o̲f̲ ̲t̲h̲e̲ ̲d̲i̲a̲g̲r̲a̲m̲ ̲i̲s̲ ̲n̲o̲