TechDocs's profile picture. TechDocs

TechDocs

@TechDocs

TechDocs

Great reminder that error messages are documentation and can be tremendously informative. A well-written error message can save your users (or yourself!) a huge amount of grief.

understand your error messages

b0rk's tweet image. understand your error messages


TechDocs repostou

📃 Documentation is a developer's first impression of your project—and *great* docs show a commitment to empathy+respect: welcoming people wherever they are, and patiently helping them move to the next level. Docs are such a powerful way to care for users, to build a community.


Last week @TechDocs hosted writers from @Uber, @facebook, @autodesk, and @LinkedIn at @TwitterSF for a 💯conversation. Looking forward to more of these! (Shoutout to Shannon B. for the pic 📷)

TechDocs's tweet image. Last week @TechDocs hosted writers from @Uber, @facebook, @autodesk, and @LinkedIn at @TwitterSF for a 💯conversation. Looking forward to more of these! (Shoutout to Shannon B. for the pic 📷)

Brilliant talk from @rionam: "Documentation is core engineering work." usenix.org/conference/sre…


TechDocs repostou

Looking for tech writers to join our @TechDocs team at Twitter. DM me if interested.


The @finagle documentation has recently been updated. Check out the new README and go from there: github.com/twitter/finagl…


"Markdown + Git = Flexible and Scalable Documentation" @patrickarlt at @writethedocs


"What users what the most: written instructions (HOWTOs) and sample code." @Moz's Zach Corleissen at #writethedocs


"Measure TTHW: Time To Hello World." @jaredbhatti at #writethedocs


"Thank your contributors. Be specific. Right away. Publicly." @brittagus at #writethedocs


"Write like Hemingway - use short sentences. Try hemingwayapp.com" @scotmarvin at #writethedocs


"Instrumentation helps documentation, and documentation helps instrumentation. Complex systems need both." @bltroutwine at #writethedocs


TechDocs repostou

Poka-yoke: Japanese for "mistake-proofing" #reliability: en.wikipedia.org/wiki/Poka-yoke


"Fix product failures instead of documenting around it." @xiongchiamiov at #writethedocs


"JavaDoc is a great tool gone bad" @iFixit at #writethedocs


"If you’ve got no documentation, it’s a bug." @DrewAPicture at #writethedocs


TechDocs repostou

I got it at @Powells. Thanks @topfunky for suggesting it at #writethedocs.

markog's tweet image. I got it at @Powells. Thanks @topfunky for suggesting it at #writethedocs.

United States Tendências

Loading...

Something went wrong.


Something went wrong.