Tutorial: Documentation with Markdown

In this tutorial, we will learn how to use Github and MarkDown to create SW documentation that describes how to our software.

Preparation

• Tutorial: Github

• Installation of Typora (You can also use Notion)

• Understand Markdown Syntax

API Documentation

In this course, you have created some numerical functions to solve mathematical problems. You should make SW documentation that explains your numerical library with some usage examples.

The documentation should contain necessary information such as

• Header File

• Class Name

• Function descriptions: syntax, description of parameters

• Example codes

Some helpful sites for API documentation

• Opencv Docs

• Keras docs

Also see Example: API documentation

Create your API(numerical library) documentation for all the functions you have created in class. You should use markdown .

• refer to Example: API documentation

Upload your documentation file in your github repository.

example: /NumericalProg/docs/NM_API_Documentation.md

You may need to add the hyperlink of API documentation in ' /docs/readme.md '

Next

Library Version Control in Github