/
How do solve the documentation technology problem?

How do solve the documentation technology problem?

What do we do with our forums - no one replies.

  • Build an entire system from scratch

    • Not impossible but a long time frame.

  • Use something like confluence but write a process which converts the confluence articles into plain HTML.

    • Gives the ability to get started quickly - since Confluence already works

    • Can address mobile.

    • Look and feel can be good

    • Opportunity to try different ways of visualizing links - D3 etc.

    • Need to

      • limit to just a subset of confluence functionality

        • Bullet points

        • Paragraphs

        • Headings

        • Links

        • Embedded pictures and videos

    • Could convert to a custom system later

    • Tracking becomes easy to get complete control -heat maps etc.

    • Good way to better understand the problem of a documentation system.

    • Some drawbacks

      • A little hard to maintain if people use edge features in Confluence.

      • Versioning is a little awkward

        • One can solve this by making multiple confluence sites - v1.0 v2.0

What is the purpose of the documentation?

 

Related content

The remote for my Trane air conditioner
The remote for my Trane air conditioner
Read with this
Finding an alternative to Confluence for the concepts site
Finding an alternative to Confluence for the concepts site
More like this
Why is our society so siloed?
Why is our society so siloed?
Read with this
Replacing Confluence
Replacing Confluence
More like this
Remove features in a design to reduce complexity
Remove features in a design to reduce complexity
Read with this
How do I use Confluence?
How do I use Confluence?
More like this