搜索

[26187] 2017-03-16_如何写出绝佳的发行说明

文档创建者：s7ckTeam
浏览次数：4
最后更新：2025-01-19
2017-03-16_如何写出绝佳的发行说明 - -   B e n   C o t t o n 2 4 % 4 6 % 5 5 % 6 1 % 6 9 % 如 何 写 出 绝 佳 的 发 行 说 明 原 创   译 者 ： S t d i o A   L i n u x 中 国   2 0 1 7 - 0 3 - 1 6 恭 喜 你 ！ 你 已 经 准 备 发 布 你 的 软 件 包 的 最 新 版 本 了 。 现 在 ， 你 需 要 保 证 你 的 发 行 说 明 整 洁 有 序 。 当 然 ， 你 可 以 写 上 一 句 “ b u g   修 复 以 及 性 能 改 进 ” 然 后 就 算 完 成 ， 但 这 并 不 能 给 你 的 用 户 传 达 任 何 信 息 。 本 文 导 航 - 入 门 - 兼 容 性 更 改 - 功 能 及 改 进 - 已 解 决 的 问 题 - 已 知 问 题 图 像 来 源 ：   o p e n s o u r c e . c o m 恭 喜 你 ！ 你 已 经 准 备 发 布 你 的 软 件 包 的 最 新 版 本 了 。 现 在 ， 你 需 要 保 证 你 的 发 行 说 明 整 洁 有 序 。 当 然 ， 你 可 以 写 上 一 句 “ b u g   修 复 以 及 性 能 改 进 ” 然 后 就 算 完 成 ， 但 这 并 不 能 给 你 的 用 户 传 达 任 何 信 息 。 发 行 说 明 同 时 用 于 支 持 和 营 销 。 它 可 以 告 诉 你 的 的 用 户 ， 为 什 么 这 个 发 布 版 本 对 他 们 很 重 要 ， 并 可 以 向 潜 在 用 户 展 示 你 的 软 件 。 所 以 ， 你 会 希 望 它 的 内 容 简 洁 、 易 懂 ， 最 重 要 的 是 ： 目 的 明 确 。 写 发 行 说 明 的 方 式 不 止 一 种 ， 所 以 本 文 只 是 一 般 提 议 ， 并 不 是 一 个 强 制 要 求 。 现 在 一 个 流 行 的 趋 势 ， 是 将 发 行 说 明 写 成 包 含 一 堆 蠢 事 的 叙 事 文 。 如 果 你 想 这 么 写 ， 那 请 自 便   — —   不 过 要 记 住 ， 笑 话 通 常 是 上 下 文 相 关 的 ， 你 觉 得 很 滑 稽 的 内 容 ， 可 能 在 你 的 读 者 眼 里 会 变 得 索 然 无 味 。 而 且 ， 不 要 忘 了 将 那 些 重 要 信 息 写 进 来 。
入 门 你 能 从 本 文 里 学 到 的 最 主 要 的 经 验 ， 可 能 就 是 这 一 条 ： 你 的 发 行 说 明 要 写 给 读 它 的 人 看 。 对 于 面 向 用 户 的 软 件 ， 发 行 说 明 中 要 注 重 面 向 用 户 的 行 为 ， 而 不 是 软 件 的 内 部 实 现 。 举 个 例 子 ： 写 “ 点 击 ‘ 取 消 ’ 按 钮 会 把 你 的 电 脑 点 着 ” ， 而 不 要 写 “ 在 c a n c e l T h a t T h i n g   函 数 中 ， t h e r m a l E v e n t T r i g g e r   的 默 认 值 被 设 为   T r u e ” 。 尝 试 将 每 一 条 说 明 限 制 在 一 到 两 句 话 。 重 点 在 于 突 出 强 调 重 要 部 分 ， 而 不 是 给 出 详 尽 的 解 释 。 如 果 你 有 一 个 公 开 的 问 题 追 踪 页 面 ， 你 可 以 在 说 明 中 包 含 问 题 链 接 （ 或 者 问 题 编 号 ） ， 这 样 关 注 此 问 题 的 读 者 可 以 通 过 链 接 来 查 看 问 题 的 详 细 内 容 。 你 并 不 需 要 严 格 按 照 这 种 方 法 来 写 发 行 说 明 ， 但 我 比 较 喜 欢 下 面 的 格 式 。 开 头 写 上 版 本 号 ， 以 及 发 布 日 期 。 对 于 主 要 版 本 ， 你 可 能 要 再 写 几 句 话 ， 来 突 出 本 次 发 布 的 主 题 。 比 如 ， “ 本 次 发 布 的 重 点 在 于 添 加 了 邮 件 客 户 端 ， 因 为 这 是 所 有 软 件 的 最 终 结 束 状 态 。 ” 兼 容 性 更 改 如 果 新 版 本 中 包 含 兼 容 性 或 默 认 行 为 的 变 更 ， 你 最 好 将 它 们 着 重 写 出 。 你 的 用 户 、 以 及 提 供 用 户 支 持 的 人 会 感 谢 你 的 。 在 发 行 说 明 中 描 述 会 遇 到 行 为 变 更 的 场 景 ， 如 何 处 理 变 更 ， 以 及 如 果 用 户 对 变 更 不 采 取 行 动 会 导 致 的 后 果 。 对 于 某 些 次 要 版 本 ， 你 可 能 没 有 任 何 会 导 致 不 兼 容 的 变 更 ， 那 你 可 以 省 略 此 部 分 。 功 能 及 改 进 现 在 ， 你 该 炫 耀 你 的 软 件 包 含 的 那 些 酷 的 、 新 奇 的 东 西 了 ， 但 是 要 记 得 站 在 用 户 的 角 度 来 写 。 比 如 ， “ 该 软 件 现 在 支 持 自 动 发 现 午 餐 照 片 ， 并 将 其 发 布 到   I n s t a g r a m   上 。 ” 已 解 决 的 问 题 没 有 软 件 是 完 美 的 ， 所 以 在 这 部 分 中 你 需 要 告 诉 读 者 ， 你 的 团 队 为 了 使 这 个 项 目 更 好 一 点 而 做 的 所 有 努 力 工 作 。 因 为 那 些 不 好 的 行 为 已 经 被 解 决 了 ， 所 以 应 该 用 过 去 式 来 写 这 一 部 分 。 如 果 某 个   b u g   的 产 生 原 因 很 明 确 ， 写 上 相 关 信 息 。 一 些 项 目 还 在 文 档 此 节 中 包 含 修 复 的   b u g 。 已 知 问 题 因 为 没 有 软 件 是 完 美 的 ， 所 以 永 远 会 存 在 未 解 决 的   b u g 。 在 这 一 节 中 ， 你 需 要 列 出 这 些 已 知 的 问 题 。 你 不 需 要 列 出 所 有 的 问 题 ； 主 要 是 影 响 功 能 的 错 误 ， 尤 其 是 那 些 在 上 个 版 本 发 布 后 发 现 的   b u g 。 这 一 部 分 的 文 字 用 将 来 时 态 写 出 。 当 你 把 这 些 问 题 解 决 ， 你 只 需 要 改 变 动 词 的 时 态 ， 然 后 把 它 们 移 到 上 个 部 分 即 可 。 作 者 简 介 ： B e n   C o t t e n   -   B e n   C o t t e n   是 一 个 受 过 专 业 训 练 的 气 象 学 家 ， 但 他 现 在 是 一 位 高 性 能 计 算 工 程 师 。 B e n   是 一 位 循 环 计 算 [ 1 ] 领 域 的 布 道 者 。 他 是   F e d o r a   的 用 户 及 贡 献 者 ， 与 他 人 一 同 创 办 了 一 个 本 地 开 源 会 议 组 ， 是 开 源 计 划 的 成 员 ， 还 是 软 件 自 由 保 护
S t d i o   A .   ( S t d i o A ) 共 计 翻 译 ： 1 4   篇 贡 献 时 间 ： 2 0 1 5 - 1 1 - 1 0   - >   2 0 1 7 - 3 - 9 的 支 持 者 。 你 可 以 在   T w i t t e r   上 找 到 他 （ @ F u n n e l F i a s c o ） 。 译 者 简 介 ： S t d i o A [ 2 ]   — —   P y t h o n e r ,   P l a y e r . v i a :   h t t p s : / / o p e n s o u r c e . c o m / a r t i c l e / 1 7 / 3 / h o w - t o - i m p r o v e - r e l e a s e - n o t e s 作 者 ： B e n   C o t t o n [ 3 ]   译 者 ： S t d i o A   校 对 ： j a s m i n e p e n g 本 文 由   L C T T   原 创 编 译 ， L i n u x 中 国   荣 誉 推 出 L C T T   译 者 相 关 阅 读 [ 1 ] :   循 环 计 算   -   h t t p s : / / c y c l e c o m p u t i n g . c o m / [ 2 ] :   S t d i o A   -   h t t p s : / / w w w . s t d i o a . c o m / [ 3 ] :   B e n   C o t t o n   -   h t t p s : / / o p e n s o u r c e . c o m / u s e r s / b c o t t o n 推 荐 文 章 <   左 右 滑 动 查 看 相 关 文 章   > 输 入 文 章   I D   或 长 按 二 维 码 直 达 阅 读 原 文
回复

举报

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

使用Markdown编辑器编辑 使用富文本编辑器编辑

Archiver| 手机版| 小黑屋|
Powered by Discuz! X3.4 Copyright © 2001-2020, Tencent Cloud. 商业源码建议获取授权，如侵犯您的权益，请联系客服处理