4 ms·
Ask HN: How do you solve internal software documentation at your company?
We have a big mix of markdown files / swagger docs / docstrings / other html/css/js docs (react storybook).
And are looking to centralize them in a way that allows for: Github authentication, search / indexing, internal commenting / discussion.
- jkjustinkumar 8y agoWe use a WordPress website with a plugin to make it into a knowlegebase wiki. First we used a plugin called UserPress. Then we moved to Zhen documsntation. Now we use a Plugin called Helpie. It's Front-end editor is good use for internal documentation.
- amirathi 8y agoI built an internal wiki replacement: nurtch.com It provides ability to create documents with markdown text, images, executable code and output all within single document. Although it's optimized for infrastructure runbooks, it can be used for any internal documentation. Reports, metrics, onboarding guides, design documents etc. If you don't foresee any need for executable code then it's probably not for you. I have seen teams use Dropbox paper, Media wiki, and sometimes Gdocs for static internal documentation.
- ahazred8ta 8y agoBTW, how do you differentiate https://nurtch.com https://nurtch.com from https://netbraintech.com https://netbraintech.com (the executable runbook people)?
- amirathi 8y agoNetBrain seems focused on network infrastructure. Nurtch is simply executable runbook platform for anything you would want to automate. Nurtch's primary use case is quick incident response for any operational issues. E.g. service outage, dependency failures, database acting up and such. Rubix library (bundled with Nurtch) helps with diagnosing and acting on these issues.
- gokulsk 8y agoWe use Atlassian Confluence (https://www.atlassian.com/software/confluence https://www.atlassian.com/software/confluence) as out Knowledgebase and document collaboration platform. It's quite to easy to manage the release notes, and editor is also good. We also use Whatfix (https://whatfix.com https://whatfix.com) to provide interactive help from within the documentation. It helps in driving users to the app and giving them overlaid interactive walkthroughs on the application.
- evervevdww221 8y agoI'm building a tool like this, but I'm 2 months from launching.