How I document — 7 tips for starting, writing and maintaining your documentation

Photo by Aaron Burden on Unsplash
Someone needs to get from A to B. The first iteration isn’t perfect but it’s better than walking… Credit — Henrik Kniberg
  • Images — a picture is worth a 1,000 words. Particularly when referencing designs or flows benefits the reader to see what you’re referencing
  • Process diagrams are an excellent way of helping others understand a flow or decision tree in a way that paragraphs of text will not. Don’t forget to include a key and a clear scope so your reader knows that the diagram does or does not cover.
  • Tables are perfect for displaying structured data. I often use them to support lists with multiple dimensions (e.g. outlining the project team — name, role, contact details and responsibilities).

Product Lead at @DeliveryHeroCom. Formerly @HelloFresh, @BBC, @Atos. Passion for product, business &tech. I like helping people solve problems. Berlin

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store