↓ Ir para o conteúdo principal

← todas as notas

📎 Webclip

Important Skills for a Technical Writer

The post says a technical writer needs technological knowledge, clear writing, problem-solving, cross-functional teamwork, communication with subject matter experts, flexibility during product changes, and the ability to present complex ideas graphically. It also says writing improves over time and that a better version of an existing document matters.

Reading notes
#

  • Research technology before writing, and keep up with enough of it to give effective and meaningful information.
  • Write clearly and concisely, and use tools like Grammarly or help from the SME when needed.
  • Treat problem solving and troubleshooting as basic skills for software documentation.
  • Stay in touch with cross-functional teams so deadlines, product releases, and product facts stay current.
  • Communicate with SMEs to support a more complete research document.
  • Be flexible with overtime and last-minute changes during product release work.
  • Present complex ideas graphically when possible, since it adds value even if it is not required.
  • Accept that writing is never perfect and that improving an existing document is part of the work.