4) Layered documentation

For text-based summaries, especially ones that will be held on a GitBook or similar, a useful principle is offering nested layers of information that allows people to drill down to the level of detail they want.

Historically, this approach comes from museum and gallery information, where often you'll see brief, top-level information on the wall, with more detailed information in a catalogue. Of course, it raises the question of what the “top level” information should actually be: deciding this is an important part of the documenter’s skill. It will vary depending on the type of meeting and the type of audience; if you are documenting for an outside organisation, it may be best decided in consultation with them.

You can see an example here of this type of documentation - note how sub-pages are used to create 2 layers of detail.

You could, of course, have more layers, offering background reading on specific topics, more detailed discussion of particular ideas, etc.

Last updated