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

科技回声

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

GitHubTwitter

首页

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

资源链接

HackerNews API原版 HackerNewsNext.js

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

Ask HN: How do you do your user-facing documentation?

9 点作者 drags超过 16 年前
This is really two questions in one. We're about to go live with our SaaS offering, but need to put together documentation for our user-facing administrator interface.<p>1. What forms do you maintain your documentation in? Little "question-mark" bubbles next to input fields? Link to HTML tree on the main page? PDF file?<p>2. What format/system for managing the documentation has worked best for you? I've done LaTeX and Docbook before, both of which should have little trouble producing nice HTML and PDF versions, but I'm still mulling over the best way to reproduce the info alongside the input fields.<p>Anyway, any advice is appreciated :)

2 条评论

limmeau超过 16 年前
For #2, I recommend Sphinx (<a href="http://sphinx.pocoo.org/" rel="nofollow">http://sphinx.pocoo.org/</a> ) as an alternative to DocBook. You write your documentation in reStructuredText (yet another extensible Wiki markup language) and generate HTML, PDF (via LaTeX), Windows help files, Eclipse help plugins etc.
mattculbreth超过 16 年前
Wow great timing, was about to ask the same thing.