documentation praxis
1/6

documentation praxis

Here are listed some praxis to document projects and code

naming convention

inline documentation

The

swagger

The common practice to document APIs is swagger as in this python example

In this case swagger reads the function definition and publishes a webpage with the formatted information about the function and composes the curl request to test the endpoint.

notion

Notion usability, feature set and ease to use was a success against tools as atlassian and jira which were well established but full of issues and complicated workflow. Notion has an increasing set of features and expanding from documentation to planning, kanban, team/project management...

alternatives