Interpreter–part 5 of n–Documentation
Series:
- http://msprogrammer.serviciipeweb.ro/2018/07/16/interpreterpart-1-of-n/ – Idea
- http://msprogrammer.serviciipeweb.ro/2018/07/23/interpreterpart-2-of-n/ – Coding
- http://msprogrammer.serviciipeweb.ro/2018/07/30/interpreterpart-3-of-n/ – Testing
- http://msprogrammer.serviciipeweb.ro/2018/08/06/interpreterpart-4-of-n/ – Deploy
- http://msprogrammer.serviciipeweb.ro/2018/08/13/interpreterpart-5-of-n/ – Documentation
- http://msprogrammer.serviciipeweb.ro/2018/08/20/interpreterpart-6-of-n/ – Ecosystem / usage
After all this steps, now it is the moment to have Documentation. Basically, if nothing have changed, is the same as the idea – http://msprogrammer.serviciipeweb.ro/2018/07/16/interpreterpart-1-of-n/ .
However , there are some points to add:
- Clear use of the software ( examples, tutorials, videos, others)
- Added badge/link to the software (nuget, see https://github.com/ignatandrei/Interpreter )
- Added badge to build ( see https://github.com/ignatandrei/Interpreter )
- Added badge to license ( see https://github.com/ignatandrei/Interpreter )
- Add reference to any third party software that you are using( any other nuget components / dot net tools – https://github.com/ignatandrei/Interpreter/blob/master/application/Interpreter/thirdParty.md )
But the most important part is to show how you use it in a real project…
Creating an open source component 983.46 KB
Leave a Reply