Documentation

What is Documentation?

Why is it important?

Types of documentation

Learning-oriented tutorials

Goal-oriented how-to guide

Understanding-oriented discussions

Information-oriented reference material

Learning-oriented tutorials

Useful when we are studying

understanding-oriented discussions

Useful when we are studying

Goal-oriented how-to guide

Useful when we are working

information-oriented reference material

Useful when we are working

Managing docs

Plan + Create

Using Version Control

Store documentation in Github

How do we write good documentation???

Be Concise

Use numbers to represent points

Lot of code and little text

Make everything easy (to copy or to paste)

Creating README.md in Github 

.md / .markdown ----> markdown extension

1. Headers

# ---> For heading 1

## ---> For heading 2 

and so on

2 . Emphasis

*  * ---> For Italic

**  ** ---> For bold

3 . Lists

* item 1

* item 2

          * item2a

          * item2b

Unordered

Ordered

1. item 1

2. item 2

           1. item2a

           2. item2b

4 . Blockquotes

Mozilla community to freshers

> Hello Freshers

                       > Welcome to the community

5 . Links

[GitHub](http://github.com)

6 . Tables

First Header  |  Second Header

----------------  | ---------------------

 Cell 1 |       Cell 2

First column | Second column

Conclusion

Good documentation is important to the success of software projects.

Thank you