Minimum Viable Documentation (MVD)

  • Define your minimum. To do that, you should talk to your colleagues who can give you an understanding of the target users and their goals.
  • Watch your competitors. This way, you can analyze and identify how such companies provide documentation about their product.
  • Assess the state of your documentation. This is applicable if you already have some documentation.
  • Define the structure. Information architecture best practices will be of great help here. This will be the initial structure that, of course, will change with time.
  • Start creating your content. Think about critical information for your users and create a basic functional framework. Minimal workflows will do for minimum viable documentation. Such as ‘Get started with…’ or ‘Accomplish a Task….’ You’ll have a chance to add to such documentation after the iteration.
  • Proceed with more complex things that your product contains. Here you might need help from SMEs (subject-matter experts). Stick to the complex aspects of the key customer workflows, crucial cases, and the essential information customers need most.
  • Get feedback and iterate. If there are important releases coming up that will affect one of the key workflows on your list, you might want to document that workflow sooner. Engineering and product management teams can give you a clue about what your customers are paying attention to, and you can edit your content accordingly.

--

--

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
Bradley Nice

Bradley Nice

Content Manager at https://medium.com/level-up-web 👈. I write about web design, web development and technical writing. Follow me on Twitter and Facebook