| Search | Refresh |
|
Stoplight
@stoplightio
|
May 8 |
|
What problems do users want to solve:
- System or task-oriented problems
@bobwatsonphd #WriteTheDocs
|
||
|
||
|
Lisa Tagliaferri
@lisaironcutter
|
May 8 |
|
How an API matches the audience's problem and skills determines how much you'll work on documentation
@bobwatsonphd
#writethedocs
|
||
|
|
||
|
|
Stoplight
@stoplightio
|
May 8 |
|
How they solve problems like their preferred coding styes, examples:
- Copy and paste code and hope for the best
- Try first and fix it by reading the docs
- Study the docs and apply the code
@bobwatsonphd #WriteTheDocs
|
||
|
|
||
|
Documentation Demon
@plaindocs
|
Sep 14 |
|
just came here to say "by catch you don't mean broadcast on twitter?" Well preempted. #writethedocs
|
||
|
|
||
|
David Smatlak
@davidsmatlak
|
May 8 |
|
#writethedocs @bobwatsonphd Fantastic presentation about API docs!
|
||
|
|
||
|
|
Lisa Tagliaferri
@lisaironcutter
|
May 8 |
|
Important to know how your users are using an API — what problems are they trying to solve? — when writing API documentation
@bobwatsonphd #writethedocs
|
||
|
|
||
|
|
Lisa Tagliaferri
@lisaironcutter
|
May 8 |
|
Develop your API documentation plan based on
Audience
Market
Product
Strategize and develop / refine plan, prioritize by content type
@bobwatsonphd
#writethedocs
|
||
|
|
||
|
Bob Watson, PhD
@bobwatsonphd
|
Sep 9 |
|
Well, I might as well just admit it.
I'm not going to get much done as long as the live tweets are coming out of the #writethedocs conference.
|
||
|
|
||
|
Mike Jang
@TheMikeJang
|
Aug 7 |
|
Thanks Bob! I think the study focuses on what Devs search for in code (only implicitly how we can modify docs to meet these needs) #WriteTheDocs
|
||
|
|
||
|
|
Bob Watson, PhD
@bobwatsonphd
|
Aug 1 |
|
|
||
|
|
||
|
Catherine Heath 💫
@awaywithwords2
|
May 8 |
|
Learning about API documentation with @bobwatsonPHD who advises use to use our audience, product and market to determine what we write. You build momentum with these things and thus create successful documentation. #writethedocs pic.twitter.com/KU1tW6j6Pf
|
||
|
||
|
|
Stoplight
@stoplightio
|
May 8 |
|
How to determine how much you will need to write based on your audience's tendencies @bobwatsonphd #WriteTheDocs pic.twitter.com/c5K86AXHhX
|
||
|
||
|
|
Bob Watson, PhD
@bobwatsonphd
|
Aug 27 |
|
Good things for #techcomm to keep in mind when communicating the value of APIs to a broader audience. #apidocs #writethedocs twitter.com/apievangelist/…
|
||
|
|
||
|
|
Bob Watson, PhD
@bobwatsonphd
|
Mar 1 |
|
The same ratio applies to the code's documentation, too. #techcomm #writethedocs twitter.com/codewisdom/sta…
|
||
|
|
||
|
|
Bob Watson, PhD
@bobwatsonphd
|
Aug 20 |
|
So far, I've found 114 articles on API documentation and I'm thinking of organizing them for a study. I'm wondering what aspects #techcomm, #writethedocs, and @stc_org think might be interesting?
I started by target audience. docsbydesign.com/2018/08/17/mor…
|
||
|
|
||
|
|
Bob Watson, PhD
@bobwatsonphd
|
Jun 17 |
|
I wonder if saying, “I don’t know” would make the answers tech gives more credible or make the tech seem less trustworthy? #writethedocs twitter.com/bendhalpern/st…
|
||
|
|
||
|
|
Bob Watson, PhD
@bobwatsonphd
|
Aug 1 |
|
Fascinating research. Talk about getting to know your audience!
#techcomm #apidocs #writethedocs twitter.com/SvenApel/statu…
|
||
|
|
||
|
|
Bob Watson, PhD
@bobwatsonphd
|
Aug 4 |
|
Interesting observations coming out of #sigdoc18, this weekend...
#techcomm #writethedocs twitter.com/JasonCKTham/st…
|
||
|
|
||
|
|
Bob Watson, PhD
@bobwatsonphd
|
Dec 11 |
|
I used to be in that target audience, so I recognize the message. The challenge for those in #techcomm who #writethedocs is to know what their readers need from the docs to help them achieve their success. Basically, know your audience with precision.
|
||
|
|
||
|
Jay Elmore
@jelmore
|
May 8 |
|
So @bobwatsonphd starts off the final talk by telling everyone what we all came to learn... #writethedocs pic.twitter.com/y5Kb105kOz
|
||
|
||