Gregory's Server
@jimfl @mhoye I have had good success when given the appropriate resources by various combinations of having technical writers flagged via codeowners for e.g. the api contract declarations, having technical writers skim review all changes on a formal release, and providing a clear and actionable grammar style guide so software engineers have a fighting chance to get it right when they write their own.
|
2 comments
 > @jimfl @mhoye whenever practical, use data structures instead of raw code constructs at the documented contract layer Nouns (data structures), verbs (API actions and events), and admonitions (what can go wrong) |
@jimfl @mhoye The important things are really to involve the technical writers as first-class collaborators and, whenever practical, use data structures instead of raw code constructs at the documented contract layer.