Create documentation that works

 

These are the key features of the Kesteven Management Documentation system designed to help with the practical tasks of building a management system —

Process charts

Process charts are a method for documenting the organization’s activities as a hierarchy of objectives and processes.  They are a standard format for presenting procedural information, making it easy to create and use.  Process charts can have point-and-click drill-downs to sub-processes, guidelines, and further information.  The process chart can also include information on which positions are account and responsible for processes and tasks. More...

Position descriptions

Positions are a page type that defines the accountabilities and responsibilities of a position within the organization.  More...

Structure and organisation charts

A structure chart is a graphic presentation of a hierarchy of pages. Structure charts are particularly intended for hierarchically organized page types such as position descriptions, but they can be created for any page type on the website.  More...

PDF creation

You can create and download a PDF document from any selection of pages in the website.  The document automatically formats your pages as documents rather than as screen shots of web pages, and the document you download will be complete with headers and footers, and optionally a title page and table of contents.  You can create a document with any pages in any order you choose. More...

Document history and version control

Version control allows you to create new versions of pages without deleting old versions.  It keeps track of all updates of a given page, and allows you to develop new draft versions of a page without changing the version that is available on the site. More...

Graphics and maps

You can upload images or maps to any page on the site.  You can also add clickable hotspots to any kind of graphic, map, or structure chart, to cross-reference areas of the graphic to other pages in the site. More...

Notifications and reminders

Notifications help users of the site keep up to date with changes.  Notifications for each user are available as a list that can be reviewed at any time.  Optionally, a user can also choose to receive all or some of their notifications by email. More...

Some hard truths of documentation

  1. The quality of your documentation sets a limit on the quality of your management. If you can’t explain it, your people can’t do it. There’s no point designing a management system that’s too complex to explain.
  2. You can’t expect your employees to be committed to working according to the documentation unless your managers are equally committed to keeping the documentation up-to-date.