导出与分享
根据阅读对象选择 Markdown、HTML 或 PDF,并检查交付文件。
选择导出格式之前,先问接收者需要阅读、继续编辑,还是长期存档。如果对方也使用 Markdown,发送原始文档和附件最便于后续修改。只需要在浏览器阅读时,可以选择 HTML。需要固定分页或打印时,再选择 PDF,并对页边距与分页进行单独检查。
导出前先清理内部备注和临时内容,检查是否包含个人联系方式、账号凭证或尚未确认的信息。文档标题应当表达具体主题,简介应当交代适用范围和前提。对于依赖特定软件版本的操作步骤,注明验证环境,避免读者把过时说明应用到不同的版本。
HTML 导出需要特别检查图片和样式的引用方式。如果文件依赖本地路径,其他人打开时可能无法读取图片。准备离线阅读材料时,应当确保所需资源与页面一起交付,或在工具支持的情况下将资源内嵌,并在断开网络的环境中打开验证一次。
PDF 的固定版式容易出现代码截断、表格溢出和标题单独停留在页尾的问题。不要只检查第一页,应当浏览每一页,尤其关注长列表、宽表格和包含中文的代码注释。打印需求还需要确认纸张大小、页码和黑白阅读效果,确保信息仍然清楚可辨。
分享完成后保留发布时的原始文件和导出文件,写明日期与版本。如果后续发现错误,记录修订内容并向接收者提供更新,而不是悄悄覆盖已经分发的材料。长期公开的说明应当定期复查外部链接,让读者能够判断信息的新旧和可信范围。