Please enable JavaScript.
Coggle requires JavaScript to display documents.
A Pragmatic Philosophy - Coggle Diagram
A Pragmatic Philosophy
it's your life
-
-
This industry gives you a remarkable set of opportunities. Be proactive, and
take them.
-
-
-
-
Communicate
It’s not just what you’ve got, but
also how you package it.
As developers, we have to communicate on many levels. A
large part of our day is spent communicating, so we need to do it well.
Know Your Audience
You’re communicating only if you’re conveying what you mean to convey. By making the
appropriate pitch to each group, you’ll get them all excited about your project. “The meaning of your communication is the response you get.”
-
Choose Your Moment
Make what you’re saying relevant in time, as well as in content.
-
-
Involve Your Audience
Involve your readers with early drafts of your document. Get their feedback, and pick their brains.
-
Get Back to People
Keeping people informed makes them far more forgiving of the occasional slip, and makes them feel that you haven’t forgotten them
Documentation
Pragmatic Programmers embrace documentation as an integral part of the overall development process. Apply all of the pragmatic principles to documentation as well as to code.
Adding comments to modules and exported functions
to give other developers a leg up when they come to use it
Restrict your non-API commenting to discussing why something is done, its purpose and its goal. The code already shows how it is done, so commenting on this is redundant—and is a violation of the DRY principle.
-