Sunday, November 10, 2019

Confluence is broken. Here's how I plan to fix it


Confluence is broken. Here’s how I plan to fix it.

Confluence, along with all current documentation tools, don’t scale with your team.

You start out with one or two people and only a few documents. At this point information is easy to find and things are going great. But then time passes and your team grows, now you have a few more documents. You can still find what you need, but it can take a while plus you notice that more and more of your documentation is becoming outdated. Still no need to panic, just make Greg work overtime, Greg loves working overtime…

More time passes, your internal wiki is getting pretty sizeable. You start needing to ask your team mates which document contains the info you need. New documents are being published every day but you aren’t sure which ones you need to be across. When you occasionally muster up the motivation to write down some of the info stowed away in your head you have no idea if anyone even read it. Not only that there is now a Greg shaped hole in the wall and the amount of times you have referenced outdated documentation is astounding. Things are looking pretty grim…

At this point documentation becomes viewed as a time sink and people start to prefer other practices like pairing, comprehensive user stories and tests. These unfortunately are only a bandaid solution to the problem, tending to put the onus back on the already time pressured staff to train people one by one.

Fear not, good people! It really doesn’t have to be this way, Greg deserves better! I’ve started developing a new tool focused on teams that aims to solve the following problems:

  1. Discoverability of documentation is very poor (woeful for the unknown unknowns)
  2. Most products don’t encourage interaction and collaboration
  3. Most products don’t give you insight into how people interact with your document.
  4. Documentation constantly becomes outdated.
  5. Documentation takes a while to write, why not allow for more free form content to document fast changing parts of your organisation?

It’s name is Scribe. Here are some juicy screenshots to tie you over until it is brought into existence with blood, sweat, tears, and a 3x3m plank of an old old wooden ship.

A B-E-A-utiful editor that encourages third party interactions
Analytics on every document so you can finally quantify how amazing your documentation really is

I have a lot of ideas when it comes to making documentation useful and dare I say it enjoyable. Personally, I think integrations are overdone, how many times do you actually use them? I don’t think 99.999% of people need an editor so powerful each document becomes an app in and of itself. Because you love hearing my opinions, hears one more. I think documentation tools are really missing the ability to have quick free-form answers to questions your team mates have. The things you are documenting can change rapidly and documentation isn’t exactly the quickest thing to write. Save the formal documentation for the slower moving content that a lot of people need to be across.

I truly believe documentation can be a massive force multiplier if it’s done right. Unfortunately Confluence and Co. haven’t shown me they are up to the challenge of making that a reality so I’m taking things into my own hands.

If what I have written resonates with you please please please get in touch or leave a comment, I want to hear about your experience. If you have ideas for a documentation tool that I haven’t touched on let me know, if they are good I will give you a year subscription for free. Lastly let me know if you would like to hear more about my epic quest to make this a reality, I’m open to more blog posts or perhaps even a vlog (the world definitely doesn’t have enough vlogs haha).



from Hacker News https://ift.tt/34PLyAE

No comments:

Post a Comment

Note: Only a member of this blog may post a comment.