Business Innovation Begins with Systems Documentation

Improving business processes begins simply enough with procedure manuals and other forms of system documentation. The Op Doc Wizard takes documentation to the next level.

Op Doc Wizard

Procedure Manual to Business Documentation to Business Innovation

 
Operational Document List Screen PDF Print E-mail
Op Doc List View

The Op Doc List may be viewed by selecting "Op Docs" from the Op Doc Wizard menu item in the menu area. The Op Doc List is the primary view for locating Op Docs. The screen shot below shows a typical view of the Op Doc List. The screen shot has several numbered cloud call-outs for particular features and actions. In the following Op Doc List discussion, bracketed numbers such as [12] refer to the numbered clouds in the screen shot. For example, [1] would refer to the cloud labeled "1".

The primary focus of the Op Doc List view is the list of currently filtered Op Docs. Six columns are displayed:

  1. a column with a check box for a heading: checking this box checks the boxes of all other rows in the table. This is useful for mass deleting, approving, etc. of op docs. [5]
  2. a column with a # sign: this is the op doc number for the Op Doc [19]
  3. Title: the title of the Op Doc [20]
  4. Tags: displays a list of all tags associated with the Op Doc [21]
  5. Comments: the number of comments currently attached to the Op Doc [22]
  6. Status: the status of the Op Doc [23]

Some of the column headings appear as hyper-links. Clicking on one of these column headings will sort the list according to that field of the Op Doc. For instance, clicking on the "Comments" heading will sort the list with the Op Docs with the most comments at the top, and the least at the bottom.

Each row in the table represents a unique Op Doc revision so multiple revisions of the same Op doc may be visible. Next to the Op Doc title [20] a yellow star may be displayed. If the star is present, this indicates that the Op Doc is considered "New" which means that it has been created or modified within the "New Period" defined in the Op Doc Wizard preferences. Clicking on the Op Doc title [6] will direct the browser to the Op Doc Detail view of that Op Doc.

Controlling the number of Op Docs displayed

Below the table of op docs is a drop down list which controls how many op docs to display per page [9] along with page numbers (if there are more op docs than are displayed on the current page). One can adjust the number of op docs displayed by changing the selected item in this list. Beware, however, that the more op docs are selected for viewing, the longer the list may take to load. It is typically best to use the filters to constrain the list to relevant op docs rather than increase the size of the list.

Sorting the Op Doc List

The list may be sorted in ascending order by any of Number, Title, Next Review Date, and Comments by clicking on the corresponding column header's title.

Filtering the Op Doc List

The real power of the Op Doc List lies in the ability to filter in or out Op Docs matching different criteria. Using filters, a user may be able to locate specific Op Docs from a massive library of Op Docs without extensive searching or browsing.

Clicking on the "Filter" menu item [1] in the menu area will expose a filter area with the following fields. The resulting search will be performed as an intersection of all of the filters. For example, results will be returned which match the Look For filter AND the Tags filter AND the Positions filter. Within each filter however, the search will be performed as a union of the options. For example, if three tags are selected: "Innovation", "Optimization", and "Improvement" the search results will include op docs that have the tag "Innovation" OR "Optimization" OR "Improvement" or any combination of those.

  1. Look for [10]: enter text into this field to perform a textual search from within the op docs. The fields that are searched and the way in which the search is performed can be custom tailored by selecting which op doc fields to include in the search and how to search for the phrase.
    • Search Fields [11]: clicking the Search Fields button reveals a check list of different fields in an op doc that may be included in the search. Placing a check next to the listed field will include it in the search, whereas excluding the check will not included it in the search. Available fields include:
      1. Title: includes text contained within the op doc's title, by default this field is selected
      2. Purpose: includes text contained within the op doc's purpose statement, by default this field is selected
      3. Content: includes the complete text of the op doc's body in the search
      4. Comments: includes the text from all comments attached to the op docs
    • Any Word / All Words / Exact Phrase [12]: only one of these items may be selected. The selected option dictates how the search phrase is used to search within the selected fields.
    • Selecting "Any Word" will search the selected fields for any occurrence of any word in the search phrase. For example, entering a search phrase of "business innovation", selecting "Title" from the Search Fields, and "Any Word" will find all op docs with the word "business" in the title AND all op docs with the word "innovation" in the title.
    • Selecting "All Words" will search the selected fields for op docs which contain all of the words in the search phrase. For example, entering a search phrase of "business innovation", selecting "Title" from the Search Fields, and "All Words" will find all op docs with the word "business" AND "innovation" in the title.
    • Selecting "Exact Phrase" will search the selected fields for op docs which contain text that exactly matches the entire search phrase. For example, entering a search phrase of "business innovation", selecting "Title" from the Search Fields, and "Exact Phrase" will find all op docs with the exact phrase "business innovation" in the title.
  2. Tags [13]: clicking the Tags button will reveal a check list of all available tags. Any op doc tagged with one or more of the checked tags will appear in the search results. It is important to note that not checking a tag does not mean that results will not include Op Docs with those tags because another of the selected tags may be matched to still return an particular op doc.
  3. Positions [14]: clicking the Positions button will reveal a check list of all available positions. Any op doc which is associated with ANY of the selected positions as either a primary position or a back up position will be returned. The behavior of matching Positions is the same as matching tags. See the Tags filter for additional information.
  4. Status [15]: clicking the Status button will reveal a check list of all possible status types that an Op Doc may have. Only Op Docs with a status matching selected status types will be included in the search results.
  5. Last Modified Date [16]: place dates in YYYY-MM-DD format in the "from" and "to" fields provided to show only op docs that were last modified within the given range. Open ended ranges are allowed.

To reset all filters to their default state, click the Reset Filters button [3]. To apply the filters and reload the Op Doc List, click the "Refresh" button [4].

Quick Jumping

One can jump directly to the most recent version of an op doc by entering the op doc number into the Quick Jump [2] field and pressing the Enter key on the keyboard. This function is useful to find an op doc for which the number is known without having to use any filters.

Actions Menu

Several actions are available depending on the currently logged in user's role / permissions.

  • New Op Doc: redirects the user to the "Op Doc Edit" screen. (See Op Doc Edit below for details)
  • Approve Op Docs: approves any op doc revisions which have been checked in the op doc list. If any op docs are selected which approval is not a valid option, this operation will fail. At least one op doc must be selected.
  • Obsolete Op Docs: obsoletes any Op Doc revisions which have been checked in the Op Doc list. If any Op Docs are selected which obsoletion is not a valid option, this operation will fail. At least one Op Doc must be selected.
  • Delete Selected Items: deletes any Op Doc revisions which have been checked in the Op Doc list. At least one Op Doc must be selected.
  • Suggest a New Op Doc: redirects the user to the "Op Doc Suggestion" screen. (See Op Doc Suggestion below for details)
Last Updated ( Thursday, 13 November 2008 09:04 )