Prescription4healthy.code

553 views
524 views

Published on

Organizing software developments in agile environments.

Published in: Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total views
553
On SlideShare
0
From Embeds
0
Number of Embeds
2
Actions
Shares
0
Downloads
0
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide

Prescription4healthy.code

  1. 1. Prescription for Healthy Code <br />by Alex Kriegel<br />(PMP, CSM, MCTS,TOGAF8 Certified Practitioner)<br />PH OIS Enterprise Architect<br />October, 2009<br />Prepared for Software Association of Oregon Event<br />
  2. 2. Code Quality<br />“Software quality measures how well software is designed (quality of design), and how well the software conforms to that design (quality of conformance)” Wikipedia<br />Code Quality – necessary (but not sufficient) condition for both<br />© Alex Kriegel<br />
  3. 3. “… the broken window effect can take root when [management] begins to tolerate downtime, constant work-arounds and broken processes.”*<br />John D. Halamka<br />CIO at CareGroup Healthcare System, CIO and<br />associate dean for educational technology <br />at Harvard Medical School<br />(just substitute developers for management, and add some sloppy code to the mix…)<br />Broken Window Syndrome<br /> * published in ComputerWorld, March 2, 2009<br />© Alex Kriegel<br />
  4. 4. Creating a Code Quality Culture<br />Educate developers<br />value of standards (and their limitations)<br />importance of development processes (and their limitations)<br />meaningful metrics as valuable feedback for code improvement<br />Promote trust among the team members<br />Use right tools for the job, and automate as much as you can<br />Educate managers about value of code quality metrics<br />© Alex Kriegel<br />
  5. 5. Code Quality<br />First and foremost: it has to work!<br />Start with the Standards and Processes:<br />coding standards (naming conventions, formatting, comments etc)<br />leveraging programming language <br />use of appropriate patterns<br />full traceability (requirements to code to bug fixes)<br />unit testing (incl. automated Regression testing)<br />meaningful metrics (Cyclomatic, NPath, Defects/KLOC etc. – where and when appropriate)<br />Continue with Change Control Process<br />© Alex Kriegel<br />
  6. 6. Tools of Trade<br />Version Control<br />Issue Tracking<br />Standards Compliance<br />Coverage Analysis<br />Code Review Process<br />Refactoring<br />Documentation Compiler<br />Logging Framework<br />Continuous Integration/Build Management<br />Automated Testing <br />Change Control Board<br />© Alex Kriegel<br />
  7. 7. Code Reviews<br />Lead code review<br />Peer code review<br />“Automated” code review<br />© Alex Kriegel<br />
  8. 8. Heterogeneous Development Environment(on shoestring budget)<br />“Why not Visual Studio Team Edition?”<br />need to support both Java and .Net development<br />budget constraints – for a small-to-moderate team size, price for VSTS stack could easily run into tens of thousands of dollars<br />integration with existing enterprise components<br />© Alex Kriegel<br />
  9. 9. Integrated Development Tools Stack (an example)<br />Developer’s Workstation<br />CheckStyle<br />FxCop<br />Hudson<br />MSTest<br />CheckStyle<br />Build Server Environment<br />© Alex Kriegel<br />
  10. 10. Java Tools<br />CheckStyle: compliance (coding standards)<br />PMD: compliance (design, localization, performance, security)<br />EMMA/Cobertura : code coverage<br />JUnit: unit testing framework<br />Logging: log4j<br />JavaDoc/Doxygen: documentation compiler<br />Maven: build management <br />Continuous integration: Hudson<br />Jira: issue tracking system<br />SVN/Subversion: version control<br />Collaboration: Atlassian Wiki<br />all rights reserved © Alex Kriegel<br />
  11. 11. .Net/C# Tools<br />FxCop: compliance (design, localization, performance, security)<br />NCover: code coverage analysis<br />Doxygen: documentation compiler<br />MSTest/NUnit: unit testing framework<br />Logging: log4net, Enterprise Library<br />MSBuild: build management <br />Continuous integration: Hudson<br />Jira: issue tracking system<br />SVN/Subversion: version control<br />Collaboration: Atlassian Wiki<br />© Alex Kriegel<br />
  12. 12. Other Free/Open Source Tools<br />© Alex Kriegel<br />
  13. 13. But what does it mean?! (an example of applied metrics)<br />“Make everything as simple as possible but no simpler…” <br />Albert Einstein<br />For instance, high Cyclomatic complexity indicates possible poor code and/or design flaws<br />Essential complexity<br />domain complexity, cannot be reduced<br />Incidental complexity [a “might be”]<br />technology induced<br />code/design problems<br />© Alex Kriegel<br />
  14. 14. Train Your Tools Well<br />Learn proper use of a tool – then tune up/customize it to produce metrics meaningful for your specific environment<br />No tool is an island – integrate tools into the development process (and SDLC)<br />Each tool has to have a master … orphaned tools wither and die<br />© Alex Kriegel<br />
  15. 15. Bigger Picture…<br />Assembling Applications with Patterns, Models, Frameworks, and Tools <br />© Alex Kriegel<br />
  16. 16. Questions ?<br />alex@agilitator.com<br />© Alex Kriegel<br />

×