In part II on your engineering superpower (technical writing), Sophie DeBenedetto talks about how to write well.

Blogging

Try these strategies to help you get started:

• Write an outline first.
• Start with a detailed introduction.
• Write the conclusion first.

If you use the conclusion first approach, focus on what the reader should walk away from your post having learned.

Pull Requests

A good PR description has a few elements:

• A descriptive title.
• An explanation of the what, why, and how.
  • ____ What problem does the code solve?
  • ____ Why is this solution needed?
  • ____ How does the code solve the problem?
• Extras: Anything from usage instructions to info on testing/QA.

How to Write a Ticket

• What problem needs to be solved and why?
• What value does the project gain by delivering this work?

How To Ask For Help

• What is the current behavior? Describe the bug that is occurring.
• Under what circumstances does the behavior occur?
• How does the behavior differ from the expected behavior?