Create || Organize ||Document

How to Document your Python Program with StremeCoder

Documentation is built into every level of StremeCoder. We provide built-in templates so documentation can be standardized as much as possible, and we make it easy to find the information you need within your program so you can understand your decision-making process while building it.

Canvas-diagram_edited.jpg

Document your program as you go along by describing each node in your flow.

Write descriptive node names so they are easy to understand.

 

Mention what problem the node is supposed to solve or what function it performs.

 

If you have a github page for the node source, you can add it for future reference.

Use our templates to save all the relevant information about your program as you are building it.

Nodes can be fully documented with online media sources from your github pages or other sources.

 

They can contain any media content, including youtube videos, you would like to use to convey how to use your node.

 

StremeCoder comes with a stock template to guide you through the normal process of documenting your node for future users.

Use a Koi Diagram (Node Diagram) to present and deliver your documentation to other people in your team, your code quality control review, or anyone else you think needs to have a clear idea of how your code works and what it does.

 

Canvas-diagram_edited.jpg

© 2020 by Pluri.  Privacy Policy