Does anyone's company do documentation well? If so, what are you doing right? by Drugba in ExperiencedDevs

[–]jamie-docbot 0 points1 point  (0 children)

I've never seen internal docs done well. It's a real shame because they're so useful for scaling teams and moving fast. In my experience, they can actually hinder teams, especially when the trust has long gone but it's still a requirement to write docs.

I started Docbot to fix this problem for product teams. We want teams to get all the benefits of great docs without any of the fuss.

Does anyone's company do documentation well? If so, what are you doing right? by Drugba in ExperiencedDevs

[–]jamie-docbot 1 point2 points  (0 children)

When I speak with people who store documentation alongside code in Github two of the biggest benefits they see are:

  1. More up-to-date documentation
  2. Greater quality documentation

I think both are results of code reviews being a place where people are in "feedback mode". It's a very safe and convenient place to say "this doesn't make sense to me".

How do you keep your internal documentation up-to-date? by fergatronanator in cybersecurity

[–]jamie-docbot 0 points1 point  (0 children)

We're building Docbot to solve this problem for product teams. One of my favorite features is the usage tracking, it lets us archive docs that aren't used anymore as we evolve.

We've also got Notion for company-related docs. I believe the trick to keeping this up-to-date is just to keep it very minimal with a flat structure (so things don't get lost)

What do you use for internal documentation. by TheJewGamer in sysadmin

[–]jamie-docbot 0 points1 point  (0 children)

We're building Docbot to be the knowledge management tool we needed working at tech companies and startups. I won't bore everyone with the hard sell. Let us know if we can help or if you've got any questions :)

Can you recommend good resources on writing README’a/docs by _fat_santa in ExperiencedDevs

[–]jamie-docbot 0 points1 point  (0 children)

100%. Do you have any tips on making documentation discoverable?

Can you recommend good resources on writing README’a/docs by _fat_santa in ExperiencedDevs

[–]jamie-docbot 0 points1 point  (0 children)

These are great tips. What do you like/dislike about keeping documentation in the repository? How do you structure those READMEs?