97 Things Every Programmer Should Know

From WikiContent

(Difference between revisions)
Jump to: navigation, search
(move Structure over Function towards completion)
Current revision (11:10, 29 August 2009) (edit) (undo)
 
(15 intermediate revisions not shown.)
Line 1: Line 1:
 +
'''''<font color="Red" size="+1">Please note that this page is no longer being used for gathering contributions.</font>'''''
 +
 +
 +
----
 +
''Create an account by clicking [http://commons.oreilly.com/wiki/index.php?title=Special:Userlogin&returnto=Special:Userlogout here]. You don't need an email invitation to create an account.''
''Create an account by clicking [http://commons.oreilly.com/wiki/index.php?title=Special:Userlogin&returnto=Special:Userlogout here]. You don't need an email invitation to create an account.''
Line 110: Line 115:
# [[Beware the Share]] by [[Udi Dahan]]
# [[Beware the Share]] by [[Udi Dahan]]
# [[Consider the Hardware]] by [[Jason P Sage]]
# [[Consider the Hardware]] by [[Jason P Sage]]
-
# [[Data Type Data Tips]] by [[Jason P Sage]]
+
# [[Data Type Tips]] by [[Jason P Sage]]
# [[Reinvent the Wheel Often]] by [[Jason P Sage]]
# [[Reinvent the Wheel Often]] by [[Jason P Sage]]
# [[Improved Testability Leads to Better Design]] by [[George Brooke]]
# [[Improved Testability Leads to Better Design]] by [[George Brooke]]
Line 138: Line 143:
# [[Implicit Dependencies Are also Dependencies]] by [[Klaus Marquardt]]
# [[Implicit Dependencies Are also Dependencies]] by [[Klaus Marquardt]]
# [[How to Access Patterns]] by [[Klaus Marquardt]]
# [[How to Access Patterns]] by [[Klaus Marquardt]]
 +
# [[Code Layout Matters]] by [[Steve Freeman]]
 +
# [[One Binary]] by [[Steve Freeman]]
 +
# [[Beauty Is in Simplicity]] by [[Jørn Ølmheim]]
 +
# [[Integrate Early and Often]] by [[Gerard Meszaros]]
 +
# [[Write Tests for People]] by [[Gerard Meszaros]]
 +
# [[Know Your IDE]] by [[Heinz Kabutz]]
 +
# [[Structure over Function]] by [[Peter Sommerlad]]
 +
# [[Message Passing Leads to Better Scalability in Parallel Systems]] by [[Russel Winder]]
 +
# [[Know Well More than Two Programming Languages]] by [[Russel Winder]]
 +
# [[Read the Humanities]] by [[Keith Braithwaite]]
=== Planning to Complete ===
=== Planning to Complete ===
Contributions in this section are not yet complete, but the authors intend to complete them before mid-August.
Contributions in this section are not yet complete, but the authors intend to complete them before mid-August.
-
# [[One Binary]] by [[Steve Freeman]]
 
-
# [[Code Layout Matters]] by [[Steve Freeman]]
 
-
# [[Message Passing Leads to Better Scalability in Parallel Systems]] by [[Russel Winder]]
 
-
# [[Read the Humanities]] by [[Keith Braithwaite]]
 
# [[Take Time to Read Other People's Good (and Bad) Code]] by [[Craig Larman]]
# [[Take Time to Read Other People's Good (and Bad) Code]] by [[Craig Larman]]
-
# [[Integrate Early and Often]] by [[Gerard Meszaros]]
+
# [[Apply Functional Programming Principles]] by [[Edward Garson]]
-
# [[Write Tests for People]] by [[Gerard Meszaros]]
+
-
# [[Reflection: Beauty or Horror?]] by [[Heinz Kabutz]]
+
-
# [[Know your IDE]] by [[Heinz Kabutz]]
+
-
# [[The Best Code]] by [[Chuck Allison]]
+
-
# [[Beauty is in Simplicity]] by [[Jørn Ølmheim]]
+
-
# [[Know Well More Than Two Programming Languages]] by [[Russel Winder]]
+
-
# [[Structure over Function]] by [[Peter Sommerlad]]
+
=== Not Planning to Complete ===
=== Not Planning to Complete ===
Line 181: Line 185:
# [[Allow faults to be diagnosable]] by [[Tony Barrett-Powell]]
# [[Allow faults to be diagnosable]] by [[Tony Barrett-Powell]]
# [[Instrumentation for Quality Control]] by [[George Brooke]]
# [[Instrumentation for Quality Control]] by [[George Brooke]]
-
# [[Apply Functional Programming Principles]] by [[Edward Garson]]
+
# [[Reflection: Beauty or Horror?]] by [[Heinz Kabutz]]
 +
# [[The Best Code]] by [[Chuck Allison]]
=== Suggestion Box ===
=== Suggestion Box ===

Current revision

Please note that this page is no longer being used for gathering contributions.



Create an account by clicking here. You don't need an email invitation to create an account.


Hi!

Welcome to the home page for developing the initial phase of 97 Things Every Programmer Should Know.

97 Things Every Programmer Should Know is intended to be a book of wisdom for programmers collected from leading practitioners. There is no overarching narrative: it is intended simply to contain multiple and varied perspectives on what it is that you feel programmers should know. This can be anything from code-focused advice to culture, from algorithm usage to agile thinking, from implementation know-how to professionalism, from style to substance, etc.

Now that we have a suitable number of complete and high-quality contributions, we're looking to move to the next phase of the project, where we open up the existing items to the public for comment and further contributions. This looks like it will be mid-August 2009. Following that we will move to the final phase of the project, publishing a book with a selection of the 97 contributions that work best together.

Thank you for taking the time and making the effort to contribute.

Kevlin Henney


Contents

What Will Come of All This?

This current site is for the initial phase of the project. In the next phase of the project, starting in August, O'Reilly will publish the contents of this wiki in a public and free web site off the O'Reilly properties. It will be free for anyone to access but you'll have to register to contribute or comment. Users (that's everyone who is registered) will be able to comment on other peoples contributions and create, edit, and improve their own contributions. Anyone and everyone be able to view the material without requiring registration. The web site will be strongly promoted by O'Reilly and all contributors will get full attribution.

After this, O'Reilly will consider taking the next step, which is to publish a 97 Things Every Programmer Should Know book. If a book is to be published, the best contributions and the contributions that fit best together will be selected and edited by me and Michael Loukides, an editor from O'Reilly. The book will sell in book stores and on-line. It will be listed as edited by Kevlin Henney. If your contribution is chosen, any recommended edits recommended will be contributed back to the 97 Things project for everyone to enjoy. Every contributor whose contribution goes into the book will be fully acknowledged in the book and will get a complementary copy of the book when it is published.

To get a feel for this type of project take a look at another book in the series called 97 Things Every Software Architect Should Know. It's the flagship project for the 97 Things series and is the first book in the series.

How to Make a Contribution

  • Each contributor is asked to provide one or more items (tips or bits of wisdom) that each have a title and associated discussion. The title should only be a 2 to 10 words long if possible and should summarize or capture the essence of the advice. In print, we want each contribution to fit on a two-page spread. Keep your discussion between 400 and 500 words. Any contribution under 400 words is unlikely to make it to the next phase of the project. And much more than 500 words will need to be edited down.
  • Create an account and author page. To create and edit a page you will need to create an account. You can then contribute your items and provide an author page. For more details on this see How to Get Started.
  • Please read the first contribution. I've added an example contribution in The Contribution section below to provide further guidelines on content style and to show you an example of what you will see when your are ready to add your own tip/axiom/pearl/guideline/contribution. Reading the initial contribution won't take long — it's not much more than 500 words!

Rules of Engagement

  • Contributors need to have an account and to create an author page. Instructions for doing this can be found here.
  • Minimize work in progress and work suggested but not started. Although it can be useful to put a place holder for an item, such as just its title or a couple of lines of content that are notes, please try to keep this to a minimum. It is more valuable to have submitted a few items that are complete and are of high quality than a long list of suggestions or partial submissions. Reducing work in progress makes it easier for you to see your own progress and for others to see the progress of the whole project. So, ideally, try to have no more than a couple of incomplete items at any one time.
  • Nominate others. Contribution is by invitation only, but you can nominate others for inclusion by contacting me with your suggestions.
  • Editing ethics. You have the ability to add or change your contributions at any time. To be a good participant, please edit your own contributions only. Be very careful that you don't accidentally alter someone else's work. As editor, I will limit my editorial changes to basic copy editing (spelling, punctuation, grammar, and formatting). I will discuss any other suggestions or comments on a contributed item directly with its author.
  • Protect the privacy of our site. Please keep this URL private sharing it only with people you invite personally to contribute. Don't link to it, digg it, put it on your web pages, send it out to a mailing list, etc. First, it's only temporary. This project will not live within O'Reilly commons indefinitely. Second, we'd like to keep this under wraps until we have a decent block of material to release.
  • Free of commercials. Please keep contributions free from references to specific products or technologies that compare their worth, or paint them in a positive or negative light.
  • Legal stuff. All contributions made to this site are required to be made under the Creative Commons Attribution 3.0 license. This means that by making a content contribution, you are agreeing that it is licensed to us and to others under this license. If you do not want your content to be available under this license, you should not contribute it.
  • Volunteers only. Contributions are made on a volunteer basis — in other words, contributors are not paid for their contributions. The contributions will be made easily available to everyone on the World Wide Web for free. However, remember that those of you whose tips are chosen for publication will get your name attached to your work, your bio published next to it, and a free copy of the published book. Any item you contribute you can also reuse in any form you wish, such as in a blog posting.
  • Submit only your own work. You warrant that all work that you contribute to this site is your original work, except for material that is in the public domain or for which you have obtained permission. Feel free to draw from your own existing work (blogs, articles, talks, etc.), so long as you are happy with the Creative Commons licence.

The Contributions

Please add your contributions in the subsections below, placing them and moving them to the subsection that best fits the state of a contribution. For guidance on the mechanics of how to contribute an item, please see How to Get Started. The following is an example contribution you may find useful as a guideline:

  1. (Example) Please Read this Guideline before Making Your Own Contribution by Kevlin Henney

Completed

Contributions in this section are effectively complete from the author's point of view, with some possible edits in the pipeline, and are ready to be moved over to the public site, mid-August. Items placed in this section must meet the word-count requirements (at least 400 words and not wildly over 500 words) and the associated author bio must also be complete.

  1. Fulfill Your Ambitions with Open Source by Richard Monson-Haefel
  2. Comment Only What the Code Cannot Say by Kevlin Henney
  3. Restrict Mutability of State by Kevlin Henney
  4. Speed Kills by Uncle Bob
  5. Encapsulate Behavior, not Just State by Einar Landre
  6. Only the Code Tells the Truth by Peter Sommerlad
  7. Interfaces Should Reveal Intention by Einar Landre
  8. Inter-Process Communication Affects Application Response Time by Randy Stafford
  9. Test for Required Behavior, not Incidental Behavior by Kevlin Henney
  10. Test Precisely and Concretely by Kevlin Henney
  11. Verbose Logging Will Disturb your Sleep by Johannes Brodwall
  12. The Road to Performance Is Littered with Dirty Code Bombs by Kirk Pepperdine
  13. Keep the Build Clean by Johannes Brodwall
  14. Use the Aggregate Design Pattern to Reduce Coupling by Einar Landre
  15. WET Dilutes Performance Bottlenecks by Kirk Pepperdine
  16. Testing Is the Engineering Rigor of Software Development by Neal Ford
  17. Make Interfaces Easy to Use Correctly and Hard to Use Incorrectly by Scott Meyers
  18. Don't Just Learn the Language, Understand its Culture by Anders Norås
  19. Small! by Uncle Bob
  20. Don't Nail Your Program into the Upright Position by Verity Stob
  21. You Gotta Care about the Code by Pete Goodliffe
  22. Know Your Next Commit by Dan Bergh Johnsson
  23. The Professional Programmer by Uncle Bob
  24. The Three Laws of Test-Driven Development by Uncle Bob
  25. Programmers Who Write Tests Get More Time to Program by Johannes Brodwall
  26. The Single Responsibility Principle by Uncle Bob
  27. The Longevity of Interim Solutions by Klaus Marquardt
  28. Prefer Domain-Specific Types to Primitive Types by Einar Landre
  29. Distinguish Business Exceptions from Technical by Dan Bergh Johnsson
  30. Don't Ignore that Error! by Pete Goodliffe
  31. The Boy Scout Rule by Uncle Bob
  32. A Comment on Comments by Cal Evans
  33. Don't Touch that Code! by Cal Evans
  34. Own (and Refactor) the Build by Steve Berczuk
  35. Deploy Early and Often by Steve Berczuk
  36. Understand Principles behind Practices by Steve Berczuk
  37. Acknowledge (and Learn from) Failures by Steve Berczuk
  38. Hard Work Does not Pay off by Olve Maudal
  39. Continuous Refactoring by Michael Hunger
  40. Scoping Methods by Michael Hunger
  41. Improve Code by Removing It by Pete Goodliffe
  42. Learn to Estimate by Giovanni Asproni
  43. Domain-Specific Languages by Michael Hunger
  44. Learn Foreign Languages by Klaus Marquardt
  45. Check Your Code First before Looking to Blame Others by Allan Kelly
  46. Two Wrongs Can Make a Right (and Are Difficult to Fix) by Allan Kelly
  47. Floating-point Numbers Aren't Real by Chuck Allison
  48. The Linker Is not a Magical Program by Walter Bright
  49. Beware the Share by Udi Dahan
  50. Consider the Hardware by Jason P Sage
  51. Data Type Tips by Jason P Sage
  52. Reinvent the Wheel Often by Jason P Sage
  53. Improved Testability Leads to Better Design by George Brooke
  54. From Requirements to Tables to Code and Tests by George Brooke
  55. Put the Mouse Down and Step Away from the Keyboard by BurkHufnagel
  56. Expect the Unexpected by Pete Goodliffe
  57. Continuous Learning by Clint Shank
  58. Don't Be Cute with Your Test Data by Rod Begbie
  59. Choose Your Tools with Care by Giovanni Asproni
  60. Decouple that UI by George Brooke
  61. Know Your Limits by Greg Colvin
  62. Do Lots of Deliberate Practice by Jon Jagger
  63. Code Is Hard to Read by Dave Anderson
  64. Simple Is not Simplistic by Giovanni Asproni
  65. Missing Opportunities for Polymorphism by Kirk Pepperdine
  66. Code in the Language of the Domain by Dan North
  67. Make the Invisible More Visible by Jon Jagger
  68. Ask "What Would the User Do?" (You Are not the User) by Giles Colborne
  69. Balance Duplication, Disruption, and Paralysis by Johannes Brodwall
  70. Methods Matter by Matthias Merdes
  71. The Golden Rule of API Design by Michael Feathers
  72. Don't Rely on "Magic Happens Here" by AlanGriffiths
  73. Prevent Errors by Giles Colborne
  74. Write Small Functions Using Examples by Keith Braithwaite
  75. Reuse Implies Coupling by Klaus Marquardt
  76. Hands on in All Phases by Klaus Marquardt
  77. Implicit Dependencies Are also Dependencies by Klaus Marquardt
  78. How to Access Patterns by Klaus Marquardt
  79. Code Layout Matters by Steve Freeman
  80. One Binary by Steve Freeman
  81. Beauty Is in Simplicity by Jørn Ølmheim
  82. Integrate Early and Often by Gerard Meszaros
  83. Write Tests for People by Gerard Meszaros
  84. Know Your IDE by Heinz Kabutz
  85. Structure over Function by Peter Sommerlad
  86. Message Passing Leads to Better Scalability in Parallel Systems by Russel Winder
  87. Know Well More than Two Programming Languages by Russel Winder
  88. Read the Humanities by Keith Braithwaite

Planning to Complete

Contributions in this section are not yet complete, but the authors intend to complete them before mid-August.

  1. Take Time to Read Other People's Good (and Bad) Code by Craig Larman
  2. Apply Functional Programming Principles by Edward Garson

Not Planning to Complete

Contributions in this section are not complete, and the authors do not intend to complete them before mid-August.

  1. Duplicate to decouple by Klaus Marquardt
  2. Two hours of thinking can save two months of coding by Giovanni Asproni
  3. Learn reading and judging code, especially your own by Peter Sommerlad
  4. Understand SCM by Steve Berczuk
  5. Don't reinvent the wheel by Kai Tödter
  6. Use the same tools in a team by Kai Tödter
  7. Collection of Collections Is a Code Smell by Kirk Pepperdine
  8. Planning for performance is not a premature optimization by Kirk Pepperdine
  9. Useful software is used longer than ever intended by Peter Sommerlad
  10. Measure, don't guess by Kirk Pepperdine
  11. Programming is a team sport by Pete Goodliffe
  12. Get the names right by Steve Freeman
  13. Plenty of domain types by Steve Freeman
  14. Logging is a user interface by Steve Freeman
  15. Don't handle errors, design them away by Michael Feathers
  16. Protection is a social problem, not a technical problem by Michael Feathers
  17. Start Small, Grow Big by Jørn Ølmheim
  18. Objects Want to be Asynchronous by Michael Feathers
  19. There is no Up or Down in Software by Michael Feathers
  20. Cohesion and Coupling matter by Tony Barrett-Powell
  21. Allow faults to be diagnosable by Tony Barrett-Powell
  22. Instrumentation for Quality Control by George Brooke
  23. Reflection: Beauty or Horror? by Heinz Kabutz
  24. The Best Code by Chuck Allison

Suggestion Box

This subsection is not for authored contributions, but for ideas you feel would benefit from being written about. You may not have the time, inclination, or background to write up a topic but still feel that it deserves to be covered. If so, please add a bullet below. And if you are looking for ideas for what to write about, please look at the list below for inspiration!

  • Program to an interface, not an implementation
  • Exception handling
  • Don't put core application logic in the UI code
  • Build tools
  • Postel's Law and/or preconditions and postconditions
  • Type conversions and type compatibility (languages have rules that can both help and hinder)
  • Concurrency
  • Team and collaboration
  • Algorithms and data structures (the importance of choosing the right ones)
  • Hardware basics that can affect program performance (such as caching level and instruction pipelines)
  • Memory usage
  • The principle of least astonishment / law of least surprise
  • Long argument lists
  • Spikes, tracer bullets, and prototyping
  • Design Patterns
  • Code Metrics / Visualization

Literature

97 Things Programmers Literature List

Personal tools