Upgrade to Pro — share decks privately, control downloads, hide ads and more …

Creating documentation for the African audience

Creating documentation for the African audience

For this talk, we surveyed various African companies in order to find out:
How they create documentation for their audience
and how they handle the workflow?
What tools they use for creation as well as feedback.

Rufai Mustapha

August 21, 2022
Tweet

More Decks by Rufai Mustapha

Other Decks in Programming

Transcript

  1. about us Mustapha Rufai Lead, Developer Engagement, Paga Benny Ifeanyi

    Iheagwara Data analyst, Technical writer, Hit Subscribe & Sematext
  2. TABLE OF CONTENTS Developer community in Africa Africa is building

    How African companies communicate to their audience? Approach to documentation Challenges, feedback , and iterative process 01 02 03 04 05
  3. 10 20 What is technical documentation? Technical documentation is content

    created (in technical language) to describe the use, functionality, or architecture of a product, system, or service.
  4. Companies ❏ Paga • Africa’s Talking Approaches • Team •

    Industry • Tools • Community • • Products
  5. • ◦ Details how to use a service ◦ Provides

    access to support team ◦ Provides best practices ◦ Provides guides • • Goals For Documentation
  6. • ◦ Details how to use a service • Provides

    access to support team ◦ Provides best practices ◦ Provides guides • • Goals For Documentation
  7. • ◦ Details how to use a service ◦ Provides

    access to support team ◦ Provides best practices ◦ Provides guides • • Goals For Documentation
  8. • ◦ Details how to use a service ◦ Provides

    access to support team ◦ Provides best practices ◦ Provides guides • • Goals For Documentation
  9. • ◦ Hosting ◦ Open api specs ◦ Libraries and

    SDK ◦ Demo ◦ Community ◦ Developer Engagement • • Tools Used For Documentation
  10. • ◦ Hosting ◦ Open API Specification ◦ Libraries and

    SDK ◦ Demo ◦ Community ◦ Developer Engagement • • Tools Used For Documentation
  11. • ◦ ◦ Hosting ◦ Open API Specification ◦ Libraries

    and SDK ◦ Demo ◦ Community ◦ Developer Engagement • • Tools Used For Documentation
  12. • ◦ ◦ Hosting ◦ Open API Specification ◦ Libraries

    and SDK ◦ Demo ◦ Community ◦ Developer Engagement • • Tools Used For Documentation
  13. • ◦ ◦ Hosting ◦ Open API Specification ◦ Libraries

    and SDK ◦ Demo ◦ Community ◦ Developer Engagement • • Tools Used For Documentation
  14. • ◦ ◦ Hosting ◦ Open API Specification ◦ Libraries

    and SDK ◦ Demo ◦ Community ◦ Developer Engagement • • Tools Used For Documentation
  15. • ◦ • Legacy Code ”Battle to conform to Open

    API Specification” • Not Dedicated Technical Writing Team • Community • Developer Engagement • • Challenges
  16. • ◦ • Legacy Code ”Battle to conform to Open

    API Specification” • Not Dedicated Technical Writing Team • Community • Developer Engagement • • Challenges
  17. • ◦ • Legacy Code ”Battle to conform to Open

    API Specification” • Not Dedicated Technical Writing Team • Community • Developer Engagement • • Challenges
  18. • ◦ • Legacy Code ”Battle to conform to Open

    API Specification” • Not Dedicated Technical Writing Team • Community • Developer Engagement • • Challenges
  19. Big thanks to the community! Special thanks to WTD, Daisy

    (M-Pesa, Safaricom), Micheal (Africa’s Talking), Blessing (Okra), and everyone who contributed. Mustapha Rufai Write the Docs Slack: rufai Email: [email protected] Twitter: @iafur Benny Ifeanyi Iheagwara Write the Docs Slack: Benny Email: [email protected] Twitter: @bennykillua