Daily Productive Sharing 138 - How to Write Good Work Documents?

(The English version follows)

#note_taking

如何撰写工作文档,如何鼓励同事写工作文档一直都是令人头疼的问题。在我以往的经历中,如果一个问题会被问到一次以上,就值得把它写成文档。这样当后面再被问到时,只要把文档拿出来就可以节省大量时间。这是为什么写文档的答案,而今天的分享则回答了如何鼓励大家写文档的问题:

  1. 提供一写足够好的文档样本,而不是完美的文档样本;
  2. 提供一些文档模版;
  3. 提供友善并且有用的反馈;
  4. 反馈时注重文档内容和质量,而不是文档格式;
  5. 提供一些文档教学

如果你觉得今天分享有帮助,不妨把它分享给你的朋友

原链

Mailbag: How to encourage good documents rather than perfect documents?

Subscribe now

如果你想更好地管理时间,并且减轻自己的压力,不妨试试 BRNR List

如果你也想成为更高效的人,欢迎加入我们的 TG group

如果大家使用邮件订阅,请把 acacess@substack.com 添加为邮箱联系人,避免邮箱过滤的误伤,谢谢:)


How to write work documents and how to encourage colleagues to write work documents has always been a headache. In my past experience, if a question will be asked more than once, it is worthwhile to put it into a document. That way when asked again later, you can save a lot of time by just passing the document. This is the answer to why you write documentation, and today's share answers the question of how to encourage people to write documentation:

  1. There’s probably four people at your company who make documents uncomfortable.
  2. Provide a structured template and document lifecycle.
  3. There’s a teachable skill to reviewing documents.
  4. Provide a designated friendly reviewer / writing coach.
  5. Provide a repository of “golden documents” with the right quality level.

If you find today's sharing helpful, why not share it with your friends?

Mailbag: How to encourage good documents rather than perfect documents?

Subscribe now

Try our sustainable productivity tool BRNR List

Please add acacess@substack.com as your contact to avoid mislabeling the newsletter as spam.


Excerpt

If documents are being shared late, it’s because some aspect of the sharing process is making authors uncomfortable.

A flexible document template will eliminate debate on structural issues.

A document lifecycle process will make it clear when to provide which kinds of feedback.

Focus feedback on the ideas rather than the format.

Going further, most folks don’t have much experience writing documents either!

Create a new list of “golden documents” which aren’t necessarily the best documents but instead those at the correct level of quality.