Artwork

Content provided by HackerNoon. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by HackerNoon or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.
Player FM - Podcast App
Go offline with the Player FM app!

Mastering User-Centric Software Documentation

4:59
 
Share
 

Manage episode 426258039 series 3474159
Content provided by HackerNoon. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by HackerNoon or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.

This story was originally published on HackerNoon at: https://hackernoon.com/mastering-user-centric-software-documentation.
Who reads your documentation? Understand the user to focus on their needs and make documentation useful.
Check more stories related to programming at: https://hackernoon.com/c/programming. You can also check exclusive content about #technical-writing, #technical-documentation, #technical-writing-tips, #software-documentation, #user-experience, #user-centric-documentation, #effective-software-guides, #software-documentation-tips, and more.
This story was written by: @akuznetsovaj. Learn more about this writer by checking @akuznetsovaj's about page, and for more stories, please visit hackernoon.com.
The User is a human being, who represents the target group. Target group will use the documentation in their everyday work to find out how to use the piece of software to fulfill their professional needs. The documentation should look like a helpful advice provided by an experienced friendly professional – this is the popular requirement from corporate style guides.

  continue reading

346 episodes

Artwork
iconShare
 
Manage episode 426258039 series 3474159
Content provided by HackerNoon. All podcast content including episodes, graphics, and podcast descriptions are uploaded and provided directly by HackerNoon or their podcast platform partner. If you believe someone is using your copyrighted work without your permission, you can follow the process outlined here https://player.fm/legal.

This story was originally published on HackerNoon at: https://hackernoon.com/mastering-user-centric-software-documentation.
Who reads your documentation? Understand the user to focus on their needs and make documentation useful.
Check more stories related to programming at: https://hackernoon.com/c/programming. You can also check exclusive content about #technical-writing, #technical-documentation, #technical-writing-tips, #software-documentation, #user-experience, #user-centric-documentation, #effective-software-guides, #software-documentation-tips, and more.
This story was written by: @akuznetsovaj. Learn more about this writer by checking @akuznetsovaj's about page, and for more stories, please visit hackernoon.com.
The User is a human being, who represents the target group. Target group will use the documentation in their everyday work to find out how to use the piece of software to fulfill their professional needs. The documentation should look like a helpful advice provided by an experienced friendly professional – this is the popular requirement from corporate style guides.

  continue reading

346 episodes

All episodes

×
 
Loading …

Welcome to Player FM!

Player FM is scanning the web for high-quality podcasts for you to enjoy right now. It's the best podcast app and works on Android, iPhone, and the web. Signup to sync subscriptions across devices.

 

Quick Reference Guide