Skip to main content

Documentation

  • One of the ways of promoting your technical vision in the company as staff engineer is influencing.
  • You need to make sure, that your tool for influencing is scalable.
  • Documentation is one of scalable tools for influencing.
  • Documentation is an asynchronous process which goes hand to hand with meetings - synchronous process.
  • Documentation can be in any forms - text, video, presentations etc.

Hints for quality:

  • Always include context in any doc.
  • TLDR section is nice, better to place in the end.

Resources:

Scaling your influence through documentation Defining a technical vision