1
1 Comment

Feedback on my idea to boost internal documentation

The problem that I'm trying to solve is that internal/tribal knowledge on a software development team is lacking and makes it rough for new devs and for experienced devs having to re-explain things.

It would be ideal for everyone to catch themselves when explaining things and switch to documentation mode, but that might not be reasonable given all of the immediate priorities.

To try and alleviate yet another thing for devs to remember to do when they get the chance, why not have a slack integration for that?

The initial idea is a slack integration that allows anyone on the team to submit a request for new documentation or an update to existing documentation. Upon formulating the request, the dev can:

  • View pending requests (to discourage submitting duplicate requests)
  • Upvote any pending requests
  • Assign the request to someone
  • Provide a brief description of what it is they are looking to accomplish with the documentation (a tutorial, how to solve a common problem, understanding how something works or why it works in a given way, etc.).

More senior developers on the team can view and manage the pending requests, also upvote them, reassign them, and ultimately pick up requests in order of most voted.

In an effort to make it easier to catch opportune times for documenting an interaction, the slack integration can detect when a questions is asked in a chat and send a prompt asking if a documentation request should be created in response to the question. Alternatively, the dev asking the question could also tag the message or thread to trigger the request process.

What do you guys think? Is this a problem that you have currently? How do you solve it today and do you think my idea can help?

  1. 1

    Let's what the problem is and what your idea is going to do to solve it ...

    Problem: lack of software documentation in project affects senior and junior devs

    Idea/Solution:

    A product, integrated in Slack, that can process a question with a flag, made in the chat, and transform it in a request to senior devs.

    The process of request for adding to documentation:

    • By default a request should be pending.
    • Senior devs can vote.
    • More than >50% of positive votes from senior devs -> an answer is added to documentation and assigned to initial question
    • Less than <50% of positive votes from senior devs -> request deleted

    What i see here ...
    you are still anoying senior devs with questions and you add votes to it ... and junior still have to wait that answers will be added to the knowledge base.

    The key here maybe the accumulation of questions. More questions answered less anoying to senior devs and less answer time to juniors.

    Pedro

Trending on Indie Hackers
Here's how we got our first 200 users 30 comments Reaching $100k MRR Organically in 12 months 28 comments What you can learn from Marc Lou 20 comments Software Developers Can Build Beautiful Software 13 comments Worst Hire - my lessons 11 comments How to Secure #1 on Product Hunt: DO’s and DON'Ts / Experience from PitchBob – AI Pitch Deck Generator & Founders Co-Pilot 10 comments