TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: How do you solve internal software documentation at your company?

8 pointsby frenchie4111about 7 years ago
We have a big mix of markdown files &#x2F; swagger docs &#x2F; docstrings &#x2F; other html&#x2F;css&#x2F;js docs (react storybook).<p>And are looking to centralize them in a way that allows for: Github authentication, search &#x2F; indexing, internal commenting &#x2F; discussion.

3 comments

amirathiabout 7 years ago
I built an internal wiki replacement: nurtch.com<p>It provides ability to create documents with markdown text, images, executable code and output all within single document. Although it&#x27;s optimized for infrastructure runbooks, it can be used for any internal documentation. Reports, metrics, onboarding guides, design documents etc.<p>If you don&#x27;t foresee any need for executable code then it&#x27;s probably not for you. I have seen teams use Dropbox paper, Media wiki, and sometimes Gdocs for static internal documentation.
评论 #17004991 未加载
jkjustinkumarabout 7 years ago
We 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&#x27;s Front-end editor is good use for internal documentation.
evervevdww221about 7 years ago
I&#x27;m building a tool like this, but I&#x27;m 2 months from launching.