Your Ultimate Information Platform

Ought to documentation writers receives a commission greater than builders?



Commentary: Given the significance of documentation to creating software program usable, ought to documentarians earn a much bigger paycheck than builders?


Picture: SIphotography, Getty Photos/iStockphoto

With out nice documentation, nice code…is not. Nice documentation, in any case, makes code extra approachable, extra helpful. Dangerous code? Effectively, as The Taproom CEO Kelly Vaughn tweeted, “Please, please, PLEASE–I’m begging you–make investments time and assets into your documentation. I have been working in circles for 3 days now attempting to resolve the identical drawback as a result of the documentation is extremely missing.”

In actual fact, for those who ask builders their most desired help for being productive with software program, as SlashData did, it is documentation. Nothing else comes shut. 

And but, it is not clear that firms worth their documentation writers accordingly. Or maybe the issue is that documentation writers do not worth themselves as a lot as they ought. RedMonk’s KellyAnn Fitzpatrick has an amazing evaluation of the Write the Docs Wage Survey 2020. However for me, the largest takeaway that’s implied however by no means acknowledged: few, together with the doc writers themselves, might worth documentation extremely sufficient.

“Docs or you do not ship it”

Once I managed Adobe’s Developer Ecosystem staff, we tried to institute a number of central tenets. One was that product groups ought to make investments extra closely within the open supply communities upon which they more and more depended. A second was that product groups ought to default to public, not non-public, APIs. Implicit on this second tenet was a perception that if a staff knew its API can be public, it could do a greater job creating and documenting the API. 

SEE: How one can construct a profitable developer profession (free PDF) (TechRepublic)

I believed then, as I consider now, that docs are vital to software program (and API) adoption. Therefore, I agree with former Twitter documentarian Troy Howard who declared: “Docs or you do not ship it.” Documentation, in different phrases, is not ancillary to the product: it’s an integral a part of the product. 

It is not shocking, subsequently, that builders cite documentation as crucial factor a software program supplier can provide them, properly above different essential choices like coaching, improvement instruments, and many others. (Determine A).

Determine A


Picture: SlashData

Nice technical writers do not merely write, as essential as that’s. Based on Fitzpatrick, “[T]he ability of having the ability to string phrases collectively per se just isn’t sufficient to make sure the manufacturing of nice technical documentation.” You could make investments time in analysis, parsing the experience of material consultants and extra. Writing is essential, however realizing what to put in writing and the best way to clarify it, is simply as essential. 

SEE: Hiring equipment: Technical author (TechRepublic Premium)

Sounds exhausting, proper? Sounds essential, too. Given how essential software program has change into to the functioning of enterprise and society, you’d assume we would pay a hefty premium for individuals who could make software program helpful for a broader viewers than it would in any other case attain.

Effectively, possibly we do.

Getting paid

In the event you have a look at Certainly’s wage information, the common base wage for a U.S.-based software program engineer is roughly $104,100, plus one other $4,000 money bonus per 12 months. If correct, that is roughly in-line with what a U.S.-based documentation author makes, in response to the Write the Docs Wage Survey 2020 information (Determine B).

Determine B


Picture: Write the Docs Wage Survey 2020

(A fast spot examine in opposition to Glassdoor and different information sources for software program engineers suggests the identical tough parity exists for different international locations.) 

I would name {that a} victory. Proper? If a software program developer goes to make $100,000, should not the documentarian make roughly the identical, provided that she will probably be simply as essential to the software program’s success? 

Most Write the Docs Wage Survey respondents (72%) appear to assume so, saying they’re “happy” with their compensation. However ought to they be? For the ten.7% of respondents who say they’re “unhappy” with their pay, their high purpose is “Pay is just too low.” And for these relative few who’re “unhappy” with their jobs, the highest purpose (cited by 46%) is “Position is undervalued or underfunded.” 

Maybe it is the author in me, Oliver Twist-style, asking, “Please Sir, I need some extra.” And possibly extra is not wanted. Perhaps documentarians make sufficient. But software program engineers hold getting paid extra, and the high 25% of builders make significantly greater than that $104,000 common. I haven’t got the information, however I will hazard a guess that one of the best documentarians do not get wherever close to the salaries of one of the best engineers, regardless of having vital, if not equal, influence. 

I would love to listen to your take. Do you assume good documentation writers ought to receives a commission the identical or greater than good software program engineers? Why or why not? Speak to me on Twitter or within the feedback beneath. 

Disclosure: I work for AWS, however the views expressed herein are mine.

Additionally see


Leave A Reply

Your email address will not be published.