TechDocs
@TechDocs
TechDocs
You might like
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.
📃 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 📷)
Brilliant talk from @rionam: "Documentation is core engineering work." usenix.org/conference/sre…
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…
"What users what the most: written instructions (HOWTOs) and sample code." @Moz's Zach Corleissen 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
Poka-yoke: Japanese for "mistake-proofing" #reliability: en.wikipedia.org/wiki/Poka-yoke
I got it at @Powells. Thanks @topfunky for suggesting it at #writethedocs.
United States Trends
- 1. Caleb 54.3K posts
- 2. Bears 77.9K posts
- 3. Packers 64.8K posts
- 4. Jeff Kent 4,907 posts
- 5. #GoPackGo 11.4K posts
- 6. Notre Dame 166K posts
- 7. Ben Johnson 6,434 posts
- 8. Nixon 13.9K posts
- 9. DJ Moore 2,981 posts
- 10. Raiders 34.6K posts
- 11. Shedeur 110K posts
- 12. Browns 79.3K posts
- 13. Kmet 1,538 posts
- 14. ESPN 121K posts
- 15. Mattingly 2,978 posts
- 16. Parsons 6,565 posts
- 17. Ravens 51K posts
- 18. #ChiefsKingdom 2,424 posts
- 19. Stefanski 32.4K posts
- 20. Josh Jacobs 4,334 posts
Something went wrong.
Something went wrong.