I worked on designing and implementing a data architecture at a FAANG. One of the things we found worked well was bringing documentation as close as possible to source - that way, making changes to one but not the other has a high rate of getting caught during code reviews and documentation stays in sync. The challenge with this approach was then accessibility for non technical customers who don’t care for nor have reason to look at source. Instead of building documentation pages, we leveraged a system that was a registry of datasets, individual columns, use cases, and sample queries... it was tricky to get right but we implemented a pipeline where documentation from code would get propagated to this system automagically.

In terms of general technical writing, style is less of a concern I have. The real challenge is writing efficiently to convey sufficient information to the audience, without staying too high level but also not providing too many details. I often suffer from writers blockz