12. EPMO Open Source Coordination Office Redaction File Detail Report

Produced by Araxis Merge on 5/8/2017 10:03:11 PM Eastern Daylight Time. See www.araxis.com for information about Merge. This report uses XHTML and CSS2, and is best viewed with a modern standards-compliant browser. For optimum results when printing this report, use landscape orientation and enable printing of background images and colours in your browser.

12.1 Files compared

#	Location	File	Last Modified
1	var-utility-web-Release-1.0.0-Branch.zip\MHED_VAR_DOCS	User+Guide.docx	Mon May 8 15:42:55 2017 UTC
2	var-utility-web-Release-1.0.0-Branch.zip\MHED_VAR_DOCS	User+Guide.docx	Mon May 8 18:26:34 2017 UTC

12.2 Comparison summary

Description	Between Files 1 and 2
Description	Text Blocks	Lines
Unchanged	1	170
Changed	0	0
Inserted	0	0
Removed	0	0

12.3 Comparison options

Whitespace
Character case	Differences in character case are significant
Line endings	Differences in line endings (`CR` and `LF` characters) are ignored
CR/LF characters	Not shown in the comparison detail

12.4 Active regular expressions

No regular expressions were active.

12.5 Comparison detail

	1	User Guide
	2	User Guide for <appl ication na me here>
	3	Version <v ersion num ber>
	4	1. Introdu ction
	5	It is diff icult to p rovide a u sers’ guid e template that fits all situa tions sinc e applicat ions vary so much in what they allow use rs to do. his templ ate is put forth for the proje ct manager or other writer to use in tai loring to the specif ic charact eristics o f the soft ware and t he project .
	6
	7	1.1. Purpo se
	8	Describe t he purpose of the gu ide, which is typica lly to fam iliarize u sers with the import ant featur es and nav igational elements o f the tool .
	9
	10	1.2. Overv iew
	11	Explain in general t erms the s ystem and the purpos e for whic h it is in tended. T he descrip tion may i nclude som e of the f ollowing e lements:
	12	List and d escribe th e major fu nctions pe rformed by the syste m
	13	Describe t he archite cture of t he system in non-tec hnical ter ms, (e.g., client/se rver, Web- based, etc .)
	14	User acces s mode, (e .g., graph ical user interface)
	15	Responsibl e organiza tion
	16	System nam e or title
	17	System cod e
	18	System cat egory:
	19	Major appl ication: performs c learly def ined funct ions for w hich there is a read ily identi fiable sec urity cons ideration and need
	20	support sy stem: pro vides gene ral comput ing or net work suppo rt for a v ariety of users and applicatio ns
	21	Operationa l status:
	22	Operationa l
	23	Under deve lopment
	24	Undergoing a major m odificatio n
	25	General de scription
	26	System env ironment o r special conditions
	27	1.3 Proje ct Referen ces
	28	1.3.1. Inf ormation
	29	Provide a list of th e points o f organiza tional con tact (POCs ) that may be needed by the do cument use r for info rmational and troubl eshooting purposes. Include t ype of con tact, cont act name, department , telephon e number, and e-mail address ( if applica ble). Poin ts of cont act may in clude, but are not l imited to: help desk POC, deve lopment/ma intenance POC, and o perations POC.
	30	1.3.2. Coo rdination
	31	Provide a list of or ganization s that req uire coord ination be tween the project an d its spec ific suppo rt functio n (e.g., i nstallatio n coordina tion, secu rity, etc. ). Includ e a schedu le for coo rdination activities .
	32	1.3.3. Hel p Desk
	33	Provide he lp desk in formation including responsibl e personne l phone nu mbers for emergency assistance .
	34
	35	1.4 Organi zation of the Manual
	36	Provide a list of th e major se ctions of the User’s Manual (1 .0, 2.0, 3 .0, etc.) and a brie f descript ion of wha t is conta ined in ea ch section .
	37
	38	1.5 Acrony ms and Abb reviations Provide a list of t he acronym s and abbr eviations used in th is documen t and the meaning of each.
	39	2. System Summary
	40	This secti on provide s a genera l overview of the sy stem writt en in non- technical terminolog y. The su mmary shou ld outline the uses of the sys tem in sup porting th e activiti es of the user and s taff.
	41	2.1. Syste m Configur ation
	42	Briefly de scribe and depict gr aphically the equipm ent, commu nications, and netwo rks used b y the syst em. Inclu de the typ e of compu ter input and output devices.
	43
	44	2.2. Data Flows
	45	Briefly de scribe or depict gra phically, the overal l flow of data in th e system. Include a user-orie nted descr iption of the method used to s tore and m aintain da ta.
	46
	47	2.3. User Access Lev els
	48	Describe t he differe nt users a nd/or user groups an d the rest rictions p laced on e ach for sy stem acces sibility o r use.
	49
	50	2.4. Conti ngencies a nd Alterna te Modes o f Operatio n
	51	At a high level, exp lain the c ontinuity of operati ons in the event of emergency, disaster, or accide nt. Explai n what the effect of degraded performanc e will hav e on the u ser.
	52
	53	3. Getting Started
	54	This secti on provide s a genera l walk-thr ough of th e system f rom initia tion throu gh exit. T he logical arrangeme nt of the informatio n shall en able the f unctional personnel to underst and the se quence and flow of t he system. Use scre en prints to depict examples o f text und er each he ading.
	55	3.1. Loggi ng On
	56	Describe t he procedu res necess ary to acc ess the sy stem, incl uding how to get use r identifi er identif ication (I D) and log on. If ap plicable, identify j ob request forms or control st atements a nd the inp ut, freque ncy, reaso n, origin, and mediu m for each type of o utput.
	57
	58	3.2. Syste m Menu
	59	This secti on describ es in gene ral terms the system menu firs t encounte red by the user, as well as th e navigati on paths t o function s noted on the scree n. Each sy stem funct ion should be under a separate section h eader, 3.2 .1 - 3.2.x .
	60
	61	3.3. Chang ing User I D and Pass word
	62	Describe h ow the use r changes a user ID. Describe the action s a user m ust take t o change a password.
	63
	64	3.4. Exit System
	65	Describe t he actions necessary to proper ly exit th e system.
	66
	67	3.5. Speci al Instruc tions for Error Corr ection
	68	Describe a ll recover y and erro r correcti on procedu res, inclu ding error condition s that may be genera ted and co rrective a ctions tha t may need to be tak en.
	69
	70	3.6. Cavea ts and Exc eptions
	71	If there a re special actions t he user mu st take to insure th at data is properly saved or t hat some o ther funct ion execut es properl y, describ e those ac tions here . Include screen ca ptures and descripti ve narrati ves, if ap plicable.
	72	4. Scenari o
	73	Prepare a scenario t hat applie s the feat ures of th e tool to the specif ic environ ment and c haracteris tics of th e project. Prepare a detailed series of instructio ns (in non -technical terms) de scribing t he procedu res the us er will ne ed to foll ow to use the system . Followi ng are exa mples of t he type of informati on that mi ght be inc luded in t he scenari o:
	74	Detailed p rocedures to initiat e system o peration, including identifica tion of jo b request forms or c ontrol sta tements an d the inpu t’s freque ncy, reaso n, origin, and mediu m for each type of o utput
	75	Illustrati ons of inp ut formats
	76	Descriptio ns of inpu t preparat ion rules
	77	Descriptio ns of outp ut procedu res identi fying outp ut formats and speci fying the output’s p urpose, fr equency, o ptions, me dia, and l ocation
	78	Identifica tion of al l codes an d abbrevia tions used in the sy stem’s out put
	79	Descriptio ns of the query and retrieval capabiliti es of the system. U se screen prints to depict exa mples.
	80	Depict and discuss a ll standar d reports that can b e generate d by the s ystem or i nternal to the user. Use scree n prints a s needed t o depict e xamples of text unde r each hea ding.
	81
	82	5. Trouble shooting
	83	Anticipate any probl ems, issue s, or item s that a u ser may ne ed assista nce with a nd provide guidance to the ext ent possib le.
	84
	85	Template last updat ed 9/10/20 14