AskOverflow.Dev

AskOverflow.Dev Logo AskOverflow.Dev Logo

AskOverflow.Dev Navigation

  • 主页
  • 系统&网络
  • Ubuntu
  • Unix
  • DBA
  • Computer
  • Coding
  • LangChain

Mobile menu

Close
  • 主页
  • 系统&网络
    • 最新
    • 热门
    • 标签
  • Ubuntu
    • 最新
    • 热门
    • 标签
  • Unix
    • 最新
    • 标签
  • DBA
    • 最新
    • 标签
  • Computer
    • 最新
    • 标签
  • Coding
    • 最新
    • 标签
主页 / server / 问题 / 38326
Accepted
Cheeso
Cheeso
Asked: 2009-07-10 06:53:47 +0800 CST2009-07-10 06:53:47 +0800 CST 2009-07-10 06:53:47 +0800 CST

如何交付 IT 工具的文档?

  • 772

我想提供一个在 Windows 上使用的 IT 工具。这个东西是一个 ISAPI 过滤器,我想描述安装、操作和配置。

目前这是在一个文本文件中完成的,它相当完整,但我认为它不是很有用。我想我对文档中应该包含的内容有很好的处理。我想输入“如何”部分。为 Windows Web 服务器管理员提供文档的最佳方式是什么?

.CHM?.PDF?.DOCX?.HTM ?

编辑:我有一个文本文件,但它变得很长,而且它的链接、交叉引用、索引和组织功能有限。让我们看看,一个主要部分用等号加下划线,一个小部分用破折号加下划线......等等。所以我尝试用这种方式格式化它,但最后 .txt 文件只是没有缩放。


更新:我选择了 SHFB。这是输出 HTML 帮助。你怎么看?可用吗?

windows iis documentation
  • 6 6 个回答
  • 447 Views

6 个回答

  • Voted
  1. Best Answer
    Evan Anderson
    2009-07-10T06:56:30+08:002009-07-10T06:56:30+08:00

    这是我的看法:

    • ASCII 文本很棒——我可以在任何地方阅读
    • HTML 是第二好的——我也可以在任何地方阅读它
    • PDF 是可以接受的,但有点烦人,因为我可能需要在没有安装 PDF 阅读器的服务器上引用它
    • 由于愚蠢的 HTML 帮助控制(感谢 HTML 帮助控制错误/漏洞!),CHM 很痛苦,而且它不是一种非常友好的剪切/粘贴格式
    • DOCX 很烦人——我的服务器上没有安装“Office”,如果我需要参考那里的文档,我肯定不会加载它
    • 4
  2. KPWINC
    2009-07-10T07:06:00+08:002009-07-10T07:06:00+08:00

    我必须使用格式正确的 ASCII 文本文件。它们可以从笔记本电脑、服务器、windows、unix、linux等中读取。

    我不应该依赖网络浏览器、adobe 阅读器、office 或任何其他程序来阅读如何在我的服务器上安装某些东西。它应该简单而无痛。

    事实是......在紧要关头......如果必须的话,我什至可以从手机中读取文本文件。

    我敢肯定,在不太理想的情况下(即从酒吧传呼、没有笔记本电脑等)凌晨 3 点被困在 colo 设施的任何人都会同意。;-)

    只是我的2美分...

    • 0
  3. Geoff Fritz
    2009-07-10T07:10:45+08:002009-07-10T07:10:45+08:00

    您应该查看asciidoc。我用它做了一些简短的事情,并且输出非常清晰(当然可以自定义)。纯文本在设计上非常易读,您可以轻松地输出文档、HTML 和 PDF。使用任意数量的其他转换器,您也可以将其转换为其他格式,例如 CHM。

    非常通用的包,不过,作为一个以 UNIX 为中心的包,我不知道 Windows 支持如何。

    • 0
  4. Anonymous
    2009-07-10T07:55:59+08:002009-07-10T07:55:59+08:00

    reStructuredText很适合我。它易于学习和使用。

    • 0
  5. Nick Anderson
    2009-07-12T21:56:54+08:002009-07-12T21:56:54+08:00

    我知道您已经接受了答案,但我想我会推荐sphinx。您在 reStructuredText 中编写文档,但可以轻松生成可搜索的 html(小型 javascript)。/

    • 0
  6. John Gardeniers
    2009-07-15T19:04:55+08:002009-07-15T19:04:55+08:00

    这是对纯文本的另一票。如果文档需要或受益于某种 HTML 插图,则可能是最佳选择,因为浏览器比其他阅读器应用程序更可能可用。

    请不要使用 DOCX 或任何其他专有格式,除非有压倒性的理由这样做(而且我暂时想不出一个)。即使您想将其创建为 Word 文件,也将其保存为 DOC,而不是 DOCX,因为有更多的软件可以读取旧格式。

    • 0

相关问题

  • 您最喜欢的云计算提供商是什么?[关闭]

  • Vanilla Powershell 是否足以成为 Windows 和 DB 服务器管理员的语言?

  • 为什么添加新驱动器后我的磁盘驱动器访问速度如此之慢?

  • 在 Windows Server 2003 下使用 wscipt 从 .asp 文件运行 .exe

  • 最佳混合环境(OS X + Windows)备份?[关闭]

Sidebar

Stats

  • 问题 205573
  • 回答 270741
  • 最佳答案 135370
  • 用户 68524
  • 热门
  • 回答
  • Marko Smith

    SFTP 使用什么端口?

    • 6 个回答
  • Marko Smith

    从 IP 地址解析主机名

    • 8 个回答
  • Marko Smith

    如何按大小对 du -h 输出进行排序

    • 30 个回答
  • Marko Smith

    命令行列出 Windows Active Directory 组中的用户?

    • 9 个回答
  • Marko Smith

    Windows 中执行反向 DNS 查找的命令行实用程序是什么?

    • 14 个回答
  • Marko Smith

    如何检查 Windows 机器上的端口是否被阻塞?

    • 4 个回答
  • Marko Smith

    我应该打开哪个端口以允许远程桌面?

    • 9 个回答
  • Marko Smith

    什么是 Pem 文件,它与其他 OpenSSL 生成的密钥文件格式有何不同?

    • 3 个回答
  • Marko Smith

    如何确定bash变量是否为空?

    • 15 个回答
  • Martin Hope
    MikeN 在 Nginx 中,如何在维护子域的同时将所有 http 请求重写为 https? 2009-09-22 06:04:43 +0800 CST
  • Martin Hope
    Tom Feiner 如何按大小对 du -h 输出进行排序 2009-02-26 05:42:42 +0800 CST
  • Martin Hope
    0x89 bash中的双方括号和单方括号有什么区别? 2009-08-10 13:11:51 +0800 CST
  • Martin Hope
    kch 如何更改我的私钥密码? 2009-08-06 21:37:57 +0800 CST
  • Martin Hope
    Kyle Brandt IPv4 子网如何工作? 2009-08-05 06:05:31 +0800 CST
  • Martin Hope
    Noah Goodrich 什么是 Pem 文件,它与其他 OpenSSL 生成的密钥文件格式有何不同? 2009-05-19 18:24:42 +0800 CST
  • Martin Hope
    Brent 如何确定bash变量是否为空? 2009-05-13 09:54:48 +0800 CST
  • Martin Hope
    cletus 您如何找到在 Windows 中打开文件的进程? 2009-05-01 16:47:16 +0800 CST

热门标签

linux nginx windows networking ubuntu domain-name-system amazon-web-services active-directory apache-2.4 ssh

Explore

  • 主页
  • 问题
    • 最新
    • 热门
  • 标签
  • 帮助

Footer

AskOverflow.Dev

关于我们

  • 关于我们
  • 联系我们

Legal Stuff

  • Privacy Policy

Language

  • Pt
  • Server
  • Unix

© 2023 AskOverflow.DEV All Rights Reserve