You might have the following problems in your engineering organisation:
Ramping up new engineers takes a very long time, sometimes more than 6 months;
You add more engineers but the velocity doesn't increase, sometimes it decreases;
Knowledge spread is highly irregular; although they work on the same project, rarely they seem to have the same knowledge, increasing the back and forth exponentially;
Engineers seem to keep busy, but things don't move forward as expected;
The little documentation the project has, was written long ago, and it went stale: nobody seems to care to update it, or even read it;
You hire senior or above engineers, yet they don't perform as expected;
Your org is misaligned.
Might seem a little too grim, but your team is approaching the "software development graveyard".
What can you do?
This is very complicated, and there is no silver bullet to fixing it, but you should know that all this originates from a weak knowledge sharing strategy within your team.
Using a knowledge management solution will ease the pain and address your problems in the long-run.
What solution should you pick?
Archbee, of course. Let us dig a bit deeper as to why.
There are many options for your team out there:
markdown files in source code:
The first time you bring up your problems, engineers will say they will write more documentation in markdown files. They won't.
Even if they will, this is not a proper knowledge management solution, because it doesn't have notifications, analytics, real-time collaboration, authentication/security, and even proper organisation.
static generated websites:
Somebody from your team will say "let's use Gatsby or Vuepress or Doxygen" or whatever the open-source community loves more at that point in time.
This is not a bad solution as long as you're willing to have somebody setup hosting, security, CI/CD, versioning and more.
But this isn't a good solution either, for the same reasons enumerated above in the "markdown files" section.
private open-source wikis:
Not much to say here other than everything said in the "static generated websites".
Only that we've all witnessed how open-source is great as long as it doesn't have a UI.
If they try to build one, it's most likely a fail.
Haha, good one. Like technical peeps like to write docs in Google Docs.
All jokes aside, Google Docs is probably a lot better than most of what teams choose to use. Same for Dropbox Paper.
Confluence is the first major player in the knowledge management solutions space.
Hate it or love it, it still has the most market share because enterprise companies buy it bundled with JIRA and Bitbucket from Atlassian. And probably has the most enterprise features.
Many developers straight out hate it and for good reason: it's slow, has an antique UI, and most importantly "the business, sales and marketing guys use it".
Disguised as "notes for your team", Slite is a better knowledge management solution than Confluence, because it's faster, has real-time capabilities, and greater UI/UX in my opinion.
The only downside is it's a generic writing tool for anybody, or nobody.
Notion is very flexible, fast, and will likely serve you better than any other solution if you're looking for a generic solution to fit all the types of teams existent in your company.
Even if it's not catered directly to technical teams, developers seem to like it more than anything else presented above.
🚀YES, here we go.
Archbee is a knowledge management solution made for engineers, by engineers.
That means ALL the features we build have the purpose to make engineering teams' life easier.
No more editing your diagram in Draw.io and linking it to your document, it's builtin.
No more hosting your own SwaggerUI, or GraphiQL, it's builtin.
No more editing code examples in weird HTML <textarea/>, we have Monaco, Visual Studio Code's editor integrated.
No more writing changelogs in plain text, changelogs are a builtin component.
No more stitching up a bunch of OSS just to host your product docs.
And more patterns met in software development are being integrated every day.
See how this works?
Every solution above is generic, they don't have a clue who is they are serving.
Archbee is very specific about the problems it's solving, and who it's solving it for.
Ya got me, but HOW DOES IT LOOK LIKE?
Glad you asked, sir/madame.
Because this blog post is actually written with Archbee's editor.
So don't be surprised when you find out the diagram below is not an image, haha.
Don't be surprised to see Monaco embedded below.
Don't be surprised to see SwaggerUI right below:
Or GraphiQL below.
Or a fancy changelog below.
Or this latency map below
I hope you see my point and understand:
Why top sales teams pick Quip;
Why top design teams pick Figma;
Why top engineering teams pick Archbee.
Let me lay it out:
THE BEST SOLUTION FOR THE PROBLEM WINS EVERYTIME!
Not generic solutions!
Archbee beats the crap out of everything out there for technical knowledge management, and you should pick it for your team.