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:
- Functional documentation
- task-oriented documentation
Following that, I was given two exercises:
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.
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.
I wrote a functional documentation about the Facebook app. You can take a look here: https://lnkd.in/dkwCQbkc
I also wrote a task-oriented documentation about HOW TO TURN OFF FACEBOOK ACTIVITY, otherwise known as META TECHNOLOGIES. You can take a look at it here: https://docs.google.com/document/d/1l3xC2t05RFAUzxM1da7Nv2aqVFdx2baZPHZszqLFZ_o/edit?usp=drivesdk
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)