DEV Community

Cover image for How To Write A Software Documentation: My First Attempt.
Alexandra Oyoh Alison
Alexandra Oyoh Alison

Posted on

How To Write A Software Documentation: My First Attempt.

Hey, friends.

What's good?

I'm currently taking a course on

Technical Writing: How to Write Software Documentation.

During my first lesson on the course today, I learned about the two types of software documentation and the strategies for writing them:

  1. Functional documentation
  2. task-oriented documentation

Following that, I was given two exercises:

  1. To create functional documentation about how to use any software application: a Facebook app, a YouTube app, a calculator app, a calendar app,  etc. This is where I describe a product/app and its intended use. I also describe what the users or customers see on the screen.

  2. To create task-oriented documentation about any software application. This focuses on how to achieve a certain result. It helps users find their way through the product or across multiple products.

P.S.: This is my first try at this, so you may encounter several errors as you read through the documentation.

I'm still growing.  😂😂

I'm open to constructive criticism, so feel free to share your thoughts with me by adding a comment when you're done reading. This will help me improve and get better at writing software documentation.

Thank you!

P.P.S: I'd really love you to read it and let me know what you think about it. 🥺

Top comments (0)