[Wanted] Programming Ethics and Documentation course

TribbleZA

Honorary Master
Joined
Feb 3, 2014
Messages
31,695
I have a client that is looking for a 1/2 to 1 day training course on Programming ethics and documentation. I have not been able to find any in Gauteng. Anyone know of places or people offering such training? Anyone specialising in this field?

I have been asked to create one, and while information is easy to come by, I would rather not reinvent the wheel.
 

Kosmik

Honorary Master
Joined
Sep 21, 2007
Messages
22,190
Never heard of a ethics course....documentation yes.
 

Pho3nix

The Legend
Joined
Jul 31, 2009
Messages
29,266
Something along the lines of Clean Coders?
Never heard of ethic coding tbh
 

Nefertiti

Honorary Master
Joined
Oct 12, 2005
Messages
17,650
I have a client that is looking for a 1/2 to 1 day training course on Programming ethics and documentation. I have not been able to find any in Gauteng. Anyone know of places or people offering such training? Anyone specialising in this field?

I have been asked to create one, and while information is easy to come by, I would rather not reinvent the wheel.

Try Wolfpack risk https://www.wolfpackrisk.com/. If they dont have a course like that maybe they can direct you in the right direction?
 

TribbleZA

Honorary Master
Joined
Feb 3, 2014
Messages
31,695
You want to copy an ethics course ? :)

No we want to buy one - or get someone to train one. I will do it if we don't find anyone. But I am sure there are people more suited to this sort of training.
[MENTION=11563]Nefertiti[/MENTION] thanks will take a look
 

TribbleZA

Honorary Master
Joined
Feb 3, 2014
Messages
31,695
To be done on a linux platform.

Actually that has not been discussed - so it could very well be :crylaugh: Doesn't actually matter - we will not be going into ethics that Deeeeeeeeply. But pretty sure the client uses some huge monopoly's OS.
 

TribbleZA

Honorary Master
Joined
Feb 3, 2014
Messages
31,695
Something along the lines of Clean Coders?
Never heard of ethic coding tbh

Clean coders? Tell me more. Ethics is a relatively new thing and is becoming rather "big" in the corporate world - what with them having access to all our data and such. It all seems very logical to most people but programmers are not most people. Programmers will do something just because it is a challenge or because they need to do it. Much like scientists that make atomic weapons or viruses, they are more interested in if they can rather than should they. They don't see themselves as the moral beacon for society whereas business wants to be responsible and feels that they need to make the coders more aware of the implications of what they are doing.

And yes - the documentation is vital of course. Have you ever had to go back to code you wrote months ago and try and figure out what it does (because you were too lazy to comment)? But there is more to documentation than just the comments in the code. So it would be nice to have an expert give the course or provide the material.
 

Kosmik

Honorary Master
Joined
Sep 21, 2007
Messages
22,190
Clean coders? Tell me more. Ethics is a relatively new thing and is becoming rather "big" in the corporate world - what with them having access to all our data and such. It all seems very logical to most people but programmers are not most people. Programmers will do something just because it is a challenge or because they need to do it. Much like scientists that make atomic weapons or viruses, they are more interested in if they can rather than should they. They don't see themselves as the moral beacon for society whereas business wants to be responsible and feels that they need to make the coders more aware of the implications of what they are doing.

And yes - the documentation is vital of course. Have you ever had to go back to code you wrote months ago and try and figure out what it does (because you were too lazy to comment)? But there is more to documentation than just the comments in the code. So it would be nice to have an expert give the course or provide the material.

I would rather force them to go on a general business ethics course. Ethics should not apply to the field you work in but be an overriding mandate regardless.

Regarding documentation, look into auto-gen code docs or a system like confluence for code.
 

TribbleZA

Honorary Master
Joined
Feb 3, 2014
Messages
31,695
I would rather force them to go on a general business ethics course. Ethics should not apply to the field you work in but be an overriding mandate regardless.

Regarding documentation, look into auto-gen code docs or a system like confluence for code.

I would agree about the Business Ethics - can suggest that to my client. And thanks for the suggestions on the docs. Will have a look.

This is actually very interesting - do you use it?
https://www.atlassian.com/teams/software
http://www.innovasys.com/product/dx/overview
http://blog.liveedu.tv/code-documentation-tools/

So much to choose from
 
Last edited:

Kosmik

Honorary Master
Joined
Sep 21, 2007
Messages
22,190
I would agree about the Business Ethics - can suggest that to my client. And thanks for the suggestions on the docs. Will have a look.

This is actually very interesting - do you use it?
https://www.atlassian.com/teams/software
http://www.innovasys.com/product/dx/overview
http://blog.liveedu.tv/code-documentation-tools/

So much to choose from

We attempted Jira about two years ago. That was Jira for helpdesk\dev and Confluence as a knowledgebase but more a knowledge base for the company or meeting plans than code. Also fiddled with Crucible earlier in the year ( Code Review ). Due to some licensing changes, it became impractical for us ( small team, 5 max but we interact with the main company of nearly 2000 ) so we did some research and switched to JetBrains. You might know them more for their Re-Sharper software? Anyway their licenses are friendlier to us and their Code Review tool I found better than Crucible, so we currently run HUB, YouTrack ( ticket ) , UpSource ( code review ) and Team City ( automated deployment\integration ). Haven't replaced the document repository but we tend to rather add code comments in code vs a separate tool. That was more as a general knowledge base but noone else in the company actually used it. We have a sharepoint installation so I'd rather move it to their but Confluence is a very nice tool for that and low cost for small teams. If we used it more, I would keep it. There is also the auto-doc tools that tie directly into visual studio code, will probably look at that next but our main code documentation is handled via a swagger interface for services.
 

Pho3nix

The Legend
Joined
Jul 31, 2009
Messages
29,266
We attempted Jira about two years ago. That was Jira for helpdesk\dev and Confluence as a knowledgebase but more a knowledge base for the company or meeting plans than code. Also fiddled with Crucible earlier in the year ( Code Review ). Due to some licensing changes, it became impractical for us ( small team, 5 max but we interact with the main company of nearly 2000 ) so we did some research and switched to JetBrains. You might know them more for their Re-Sharper software? Anyway their licenses are friendlier to us and their Code Review tool I found better than Crucible, so we currently run HUB, YouTrack ( ticket ) , UpSource ( code review ) and Team City ( automated deployment\integration ). Haven't replaced the document repository but we tend to rather add code comments in code vs a separate tool. That was more as a general knowledge base but noone else in the company actually used it. We have a sharepoint installation so I'd rather move it to their but Confluence is a very nice tool for that and low cost for small teams. If we used it more, I would keep it. There is also the auto-doc tools that tie directly into visual studio code, will probably look at that next but our main code documentation is handled via a swagger interface for services.

Full suite is Jira (for tickets and scrum),bitbucket(Code Repo), Bamboo(automated build tool), Confluence as the knowledge base.
For a smaller team I do agree JetBrains suite might be more effective.

What language you dev'ing in if you don't mind me asking.
 

Kosmik

Honorary Master
Joined
Sep 21, 2007
Messages
22,190
Full suite is Jira (for tickets and scrum),bitbucket(Code Repo), Bamboo(automated build tool), Confluence as the knowledge base.
For a smaller team I do agree JetBrains suite might be more effective.

What language you dev'ing in if you don't mind me asking.

Primarily c#. Heavy web based, MVC frontends targeting common webservice API layer with a Repo pattern and Dapper for persistence ( super fast ). We also work on apps but played with Xamarin and native android before settling on current stack of Ionic for cross platform. The core is the API layer, language agnostic for wherever its needed be it web, mobile, app or service. Hence why I say our Swagger is our main documentation tool for code besides comments. https://swagger.io/
 

gkm

Expert Member
Joined
May 10, 2005
Messages
1,519
There are also some Uncle Bob videos on Youtube around ethics in software development, which you might be able to use as a basis for something.
 

cguy

Executive Member
Joined
Jan 2, 2013
Messages
7,639
I feel like I've sinned every time I const cast a const away in C++.
 
Top