文档质量之从客户角度来找茬

1. 信息不完整,客户读完仍然不知道该怎么做,可能需要求助技术支持。It's not easy to use.

示例:

Before you can install agents, you must configure the downloaded agent installation images for communication with the xxx server. The agent framework is not included in the downloaded agent installation images. The agent framework is installed in the Agent Frameworks directory during the xxx server installation. The agent framework is injected into installation images during configuration.

Suggestion:

Before you can install agents, you must configure the downloaded agent installation images to apply the agent framework for communication with the xxx server. The agent framework is installed in the Agent Frameworks directory during the xxx server installation. It’s not included in the downloaded agent installation images. Only after the agent image configuration, the agent framework can be injected into the installation images.

Reason:

As a fresh learner, I do not know why the first sentence is about "configuring agent image", while the other sentences are about "framework". What is the relationship between "configuring agent image" and "framework"?

I think it is better to add the relationship between "configuring agent image" and "framework". In this way, a fresh learner can understand these sentences more easily.

2. 步骤描述不具体,客户需要想半天才知道要怎样做。It's not easy to understand.

示例 1:

Make the GNU version your default tar command. Complete one of the following steps:

• In the PATH environment variable, put the following variable first:

export PATH=/opt/freeware/bin:$PATH

Suggestion:

Add /opt/freeware/bin to the beginning of the current PATH environment variable. For example:

export PATH=/opt/freeware/bin:$PATH

Where /opt/freeware/bin is the directory of GUN bin.

Reason:

It's better to give more details about the PATH environment variable setting for customer to understand.

示例 2:

Replace /bin/tar with symbolic link to /opt/freeware/bin/tar

Suggestion:

Replace /bin/tar with symbolic link to /opt/freeware/bin/tar as below:

ln -s /opt/freeware/bin/tar /bin/tar

Reason:

By adding the specific command example, it will be quicker for customer to follow the step, especially those fresh learners.

3. 表达过于含糊,不知所云。

示例:

Before the prerequisite scanner is updated for the latest supported release, for some agents, you can bypass the prerequisite scanner to have this supported release sooner. For suitable scenarios and instructions, see “xxx” on page 193.

Reason:

It’s hard to understand the sentence.  What does the sentence "Before the prerequisite scanner is updated for the latest supported release" mean?

Suggestion:

Before the prerequisite scanner is updated to be compatible with the latest requirements, for some agents, you can bypass the prerequisite scanner.

4. 信息不准确,给客户的是错误的信息。

示例:

Remove or add the '--' prefix at the beginning of grant statements to skip the granting execution for those unauthorized Oracle tables or views.

Suggestion:

Add the '--' prefix at the beginning of grant statements to skip the granting execution for those unauthorized Oracle tables or views.

Reason:

The purpose is to skip the execution. So only adding the prefix to comment the statement, not removing the prefix.

5. Short description 没有描述新 feature 对客户的意义,而只是描述如何使用。客户不了解意义,就不会使用该 feature。一个好的文档应该是易用理解、易用使用和易于找到的。但同时,也要能完整的展示 dev team 增加该 feature 的初衷,尽可能吸引客户眼球。

参考《DITA 文档有哪些类型?》(https://www.jianshu.com/p/00f78087de75)

6. 文档 TOC 逻辑不清。It's not easy to find.

- 没有按照 Day 0、 Day 1、Day 2 来组织。

- 没有架构图以及部署路线图。

- 没有重要概念描述。

- 没有 Personas。

7. 低级语法、拼写、标点、链接失效问题,导致客户对产品印象差。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容