🥁First strategy #webinar of the year: 31 January❗ Join @kvantomme to learn about how to build your #strategy for c… https://t.co/pTIjAapD7s
This talk was presented at API The Docs Virtual 2020 event series on 7 October. We are honored to share the video recording, slide deck, and talk summary below. Enjoy!
Visit the API The Docs 2020 recaps overview to explore all presentations this year.
Technical Writer and Documentation Specialist at ReversingLabs
How can a technical writer make a difference and change broken API design processes? Why is it an obstacle if the API design process is not making use of API definitions?
It is necessary for the techwriter to pursue this approach, and it is in their best interest, also.
An uncoordinated design process might result in an API version that is totally different from the one planned and may challenge swagger improvements.
Problems can be related to:
Consequences:
If customers are asking for something you can’t deliver or development is not achieving goals on time, this cannot be just a documentation problem and needs to be dealt with on a higher level.
Framing it as a business problem - which it actually is
a.) Make sure everyone is on the same page that this is a problem you should tackle all together
Being the teacher
a.) Educate, organize workshops, show how to use various tools
Demonstrate automation with API definitions
a.) Introduce the idea of automated testing, show how to generate reference docs, provide advice for using linters
If experiencing resistance
a.) Understand reasons for resistance - don’t take it personally, receive it with empathy
Taking responsibility
a.) Participate in API design sessions and observe pain points
🥁First strategy #webinar of the year: 31 January❗ Join @kvantomme to learn about how to build your #strategy for c… https://t.co/pTIjAapD7s
We're excited to bring you the new virtual sessions of #APItheDocs focusing on the importance of #feedback #metrics… https://t.co/ifmptrM2bk
The #APItheDocs Virtual series returns in January, focusing on what is worth measuring on the community side of do… https://t.co/hS5D5ZzGg0
💡What are the essential elements of #developerportals? 💡How do you build a strategy that creates and catalyzes grea… https://t.co/5xstaoMV2w