TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

Ask HN: Future proof project documentation?

1 点作者 dktoao超过 4 年前
I have been tasked with coming up with ideas for the best way to migrate a very large and very fragmented documentation base spanning 30+ years to a more manageable system. The current documentation is in every proprietary file format &#x2F; cloud system imaginable (Lotus Notes, GDoc, SharePoint, shared network folders).<p>In my dreams I would like everyone to start maintaining all documentation in plain text (markdown probably?), checked in the same repository as the source code, with possibly a simple cron job to convert everything to a static html webpage every night. While I think this is the best system, discussing casually with colleagues (mostly EE, not CS) has revealed the following roadblocks to my plan:<p>1. Reluctance to learn Markdown, which is seen as a new fancy technology to learn. Given the math heavy lean of the documentation, and the mess that is Latex math notation, is sort of understandable. Also, I am worried about the lack of a standard for Markdown, but I like how instant it is to learn.<p>2. Limited knowledge on the team of the small amount of web technology that it would take to maintain this infrastructure.<p>The last thing that I want to do is to go back to a proprietary platform as our IT group pulls this rug out on us every ~5 years. I tried a web search but mostly came up with quick buzz-word heavy blogs and landing pages for proprietary systems.<p>Does anyone have any experience doing this for documentation? What are the drawbacks? Are there any pitfalls that I am missing that make this a foolish idea? Any high quality resources or blog posts that I can take ideas from?<p>Thanks in advance!

暂无评论

暂无评论