Alase4034
3
文章
3052
查看
0
关注者
DOCUMENTATION
The market is breathing like with green and red, but documentation never stops.
Are you confused about what I meant by documentation?
No, you don't have to be scared because as a Technical writer I am to simplify and break all the jargons you have seen before now in a way that you could explain to your grandpa.
Let me explain to you what documentation is all about?
What is Documentation?
Documentation is like a book either softcopy or hardcopy that explains everything you need to know about a product, software, or system.
In scenarios like a product, it will tell you how the product works, how to use it to your benefit and how it was built.
What is the Use of Documentation?
Record Keeping: It is used to keep records e.g. project, products so you don't forget and can also track them easily.
➠ A Guide: It is used as a guide for solving a problem or how to use a product.
➠ A Director: It can be seen as a director, that directs on what to do and what not to do.
Types of Documentation
We have so many types of documentation. Everyone of us makes use of documentation on a daily basis but we might not be aware because you are not well informed.
I will be explaining the types of documentation and how you have been using them.
➠ Software Requirement Specification (SRS): It is a document that tells you all details you need to know about a particular software and how it can be of use for you.
➠ Tutorial: A guide that will educate you how to build or use a particular project or product from the scratch.
➠ Privacy Policies: A document that explains to users about your privacy and policy guiding along with the consequences of your action in the document.
➠ Bug Report: A detailed document that entails the error users encounter while using a product also indicating how they were able to navigate and bypass the error.
➠ Product Roadmap: A document that explains to you the plan of a project in the nearest future and when you are to expect them to execute the plan or add features.