(PDF) Ship it! A Practical Guide to Successful Software Projects
It is a good book but very old and most of the suggestions have already become de facto standard in the industry Thus 4 stars Ship ItA collection of lessons learned by various developers in the trenches The book starts off with a uote of Aristotle We are what we repeatedly do Excellence then is not an act but a habit The book strengthens this argument by stating Extraordinary products are merely side effects of good habits So the first tip of the book is Choose your habits Do not follow something ust because it is popular or well known or is practised by others around youThe author says that there are three aspects that one needs to pay attention to1 Techniues How the project is developed Ie Daily meetings Code Reviews Maintaining a To Do List etc2 Infrastructure Tools used to develop the project Ie Version Control Build Scripts Running Tests Continuous Build etc3 Process The process followed in developing the applications Propose Objects Propose Interfaces Connection Interfaces Add Functions Refactor Refine RepeatTools and InfrastructureThe author highlights the need for a proper tool for Source Control Management The author also issues a warning that the right tool should be chosen A tool should not be chosen because it is backed by a big ticket organization Vendors would push for supertools but one needs to exercise discretion when choosing between the toolsGood Development Practices1 Develop in a Sandbox ie changes of one developer should not impact the other until the changes are ready2 Each developer should have a copy of everything they need for development this includes web server application server database server most importantly source code and anything else3 Once all the changes by the developer are finished they should check it in to the Source Control so that the others can pick up and integrate it with their code and make any changes they need to make to integrate4 The checked in changes should be fine grainedTools Reuired for ensuring Good Development Practices1 SCM2 Build Scripts3 Track IssuesWhat to keep in SCM1 While it can be debated whether runtimes like Java need to be kept in the SCM it is important that all the third party libraries Black and White Strangers: Race and American Literary Realism jars dlls and configuration templates be available in the SCM Note that configuration templates need to be available as the contents itself can change from environment to environment2 Anything that is generated as part of the build processars dlls exes war should not be stored in the SCMWhat a Good SCM should offer1 Ensure that the usage of SCM is painless to the developers The interactions with the SCM should be fast enough to ensure that the developers do not hesitate to use it2 A minimal set of activities that should be supported by the SCM are Check out the entire project Look at the differences between your edits and the latest code in the SCM View the history for a specific file who changed this file and when did they do it Update your local copy with other developers changes Push or commit your changes to the SCM Remove or back out the last changes you pushed into the SCM Retrieve a copy of the code tree as it existed last TuesdayScript the BuildOnce the reuired artefacts are checked out from the SCM it should be possible for any developer to run a script and have a working system sandbox of her own to work on For this one needs a Build Script This should be a completely automated build reuiring no manual intervention or steps This build script should be outside of the IDE so that it can be used irrespective of the IDE being used The IDE could use the same script for local buildsOnce the one stepcommand build script is ready automate the build Ideally everytime a code is checked in the following should be done1 Checkout the latest code and build2 Run a set of smoke tests to ensure that the basic functionality is not broken3 Configure the build system to notify the stakeholders of new code checked the build and the test resultsThis is called Continuous IntegrationTracking the IssuesIt is important to track the issues that are reported for the application so that they can be tracked and fixedAt a bare minimum one needs to know the following about an issue What version of the product has the issue Which customer encountered the issue How severe is it Was the problem reproduced in house and by whom so they can help you if you re unable to reproduce the problem What was the customer s environment operating system database etc In what version of your product did The Issue First Occur issue first occur what version of your product was it fixed Who fixed it Who verified the fixSome that will help in the long term During what phase of the project was the bug introduced The root cause of the bug The sources that were changed to fix the problem If the checkin policy demands that the checkin comment indicate the reason for the fixes then it should be possible to correlate the checkin with the issue that they fixed or reuirement that they addressed How long did
it take to fix the error Time to analyze Fix TestSome warning signs that things take to fix the error Time to analyze Fix TestSome warning signs that things not OK with the issue system The system isn t being used Too many small issues have been logged in the system Issue related metrics are used to evaluate team member performanceTracking FeaturesJust as it is important to track the issues it is important to track the features that have been planned for the applicationThe system used to track issues may also be used to track the features as long as it provides the ability to identify them separatelyTestingHave a good Test Harness which can be used to run automated tests on the system1 Use a standard Test Harness which can generate all the reuired reports2 Ensure that every team member uses the same tool3 Ensure that the tool can be run from the command line This will enable driving it from an external script or a tool4 Ensure that the tool is flexible to test multiple types of applications and not specific to a particular typeDifferent types of testing needs to be planned for1 Unit Testing Testing small pieces of code This forces the developers to break up the code into smaller pieces This makes is easier to maintain and understand reduces copy paste ensures that overall functionality is if at all minimally impacted by refactoring2 Functional Testing Testing all the functions of the I like Am I doing this right parts the most They help us to check some uestions if we re on the right path The cost of adding a feature isn t ust the time it takes to code it The cost also includes the addition of an obstacle to future expansion the trick is to pick the features that don t fight each other Tools and Infrastructure1 Develop in a SandboxEvery dev has their own sandbox to play in without disturbing other devs It applies to all resources source code database instances web services on which you depand and so onDev PCs Repository Build Machine Released Product2 Manage AssetsSource code management system or version control With a properly set up SCM system you can Rolled back Handle conflicts Track multiple versions of your software Record which files are changed Retrieve a snapshot3 Script your buildAt a minimum use a batch file or shell script to perform the buildIf you re using your manual build system properly you will be able to build your entire product With one command From your Source Code Management system SCM On any team member s workstation With no external. Ship It is a collection of tips that show the tools and techniues a successful project team has to use and how to use them well You'll get uick easy to follow advice on modern practices which to use and when they should be applied This book avoids current fashion trends and marketing hype; instead readers find page after page of solid advice all tried and tested in the real worldAimed at beginning to intermediate programmers Ship It will show youWhich tools help and which don't How to keep In the details of each piece of the system It is important as the pieces are build that the total system integration never breakFinally the last section answers the burning uestions most people will have after reading the book How to I get over this roadblock How do I handle a situation where people are not on board etcIn summary I recommend this book to be read cover to cover by any novice developer or any developer who looks at the table of contents and fins many of the topics foreign to them For the rest of the folks skimming this book would be a great review and having it as a reference on your shelf could prove to be useful especially the last section and the appendix Though some pieces of advice in this book do look obvious in 2019 you ll most likely find a couple of good and simple ideas that can make you focused and productive I found The List particularly useful for my environmentA very good help for newly converted teamtech leads Even teams working for the most successful tech giants and enjoying using state of the art infrastructure can benefit from adopting some of the practices presented in this book My team definitely can I saw Jared Richardson speak He s a great speaker but he seemed to indicate that scrum wasn t really such a solid winner in the agile methodology space when the book was written This is apparent as he seems to take some ideas from scrum when I would personally prefer to ust do scrumHe does a good ob of tying together scrum XP agile and all around good practices Asinine unambitious narrow incomplete Some of the groundbreaking advice contained herein Sort your work by priority and do the highest priority ones first Do a high level class design before you write object oriented code Adhere to standard object oriented encapsulation Talk to other developers about how your code needs to fit into theirs You should test your code changes before you go live Have you about this new source control thingHere s a direct uoteDon t have much money in the budget for training Then point your team at the Internet and turn them loose These days there s information about anything on the Internet than anywhere else and most of it is free Of course you can t believe everything you nd there take what you nd with a grain of salt So don t limit your team s access to the Internet Sure they might surf some non work related sites but the good stuff they nd will than make up for itI m not ust being a Berlioz and the Romantic Century jerk right Doesn t it feel a little weird to be advised to look things up on the Internet Who needs to be told this What do they mean these days The Internet has been full of free advice on programming LITERALLY since it beganIt s hard to believe that a developer at a high enough level to apply this kind of advice would even need it I know the book s from 2005 but come on This is written for an audience who somehow knows how to program but knows nothing about completing projects with than one step involving than one person who now somehow landed a developmentob at a company full of people eually as clueless and with no desire to collaborate That has literally never happenedI m setting aside the fact that software projects of the book s subtitle often involve things like maintenance and administration which involves tasks that fall almost completely outside of the rubrics suggested in the bookSorry I Building Ideas: An Architectural Guide to the University of Chicago just don t get it This book contains short guide and many extremely practical advises I do think that some of them should be substituted with newer list of CI systems and etc BUT advises themselves not outdated at all I highly recommend to read this book for people who has legacy code to work with or projects that are in the stale state Practical handbook that help team to move from dark side to light and become aedi Most important thing is sharing authors expirience that based on a work in different companies with different sizes After you have read this book you will understand not only the weak points of your development organization process but can change situation in the right direction Ship It A Practical Guide to Successful Software Projects by Jared Richardson and William Gwaltney Jr is a bit of mixed bag There is good stuff in there but the book tries to be too much and as
a conseuence it is at times too sketchy and incomplete In addition conseuence it is at times too sketchy and incomplete In addition authors prescribe techiues that are not always appropriateThe book covers three software engineering topics tools project techniues and a methodology The chapter on tools and infrastructure is solid They recommend that you implement developer sandboxes software configuration management scripted builds continuous integration issue and management scripted builds continuous integration issue and tracking systems and automated testing on your projects and I agree In any project of than a trivial duration where there are no huge technical barriers due to the products you are working with you should implement all of themThe chapter on project techniues is less convincing Some of the techniues are unproblematic Having a short meeting every morning to make sure that everyone is on the same page and sending code change notifications for instance Others seem to prescribe a way of working that might not be the best in your case For instance they have a simple scope management techniue the call The List which is essentially ust that a list of all the work that needs to be completed On small projects this probably works okay but when projects get big you might be better off with a work breakdown structure and a schedule with dependencies all thatAnother example is their recommendation for freuent short and informal code reviews Collaborative development techniues such as code reviews is a good idea Research has shown that this is the most cost effective way to increase software uality However research also shows that formal inspections are even effective In cases where high uality is important it would probably be a better optionThe chapter also seems a bit incomplete It seems like an embryonic agile method Another reviewer noted that when the book was written methods such as Scrum were not yet established In my opinion you are probably better off with Scrum if you decide that agile is appropriate for your projectTheir project method on the other hand is interesting Unfortunately the chapter describing it is a bit too sketchy for my taste Also it is of a software integration strategy than a full blown software engineeering methodology They call the method tracer bullet development named after the bullets that allow you to see where you are firing your machine gun in the darkEssentially you start by dividing your system into layers eg the GUI layer the business logic layer and the data access layer Then you identify you system objects in each layer and the interaction between them These objects and their interfaces are then implemented as stubs and integrated into a
working system Then you start filling in the blanks and elaborating the interfaces keeping the system integrated system Then you start filling in the blanks and elaborating the interfaces keeping the system integrated of the way This strategy has several benefits Having done the integration up front you avoid the nerve wracking tying together of components at the end of the implementation The interface orientation promotes cohesion and loose coupling making the software robust and scalableAll in all there is good stuff in there but one has to wonder whether the book was the victim of time boxed development and premature shippin. D Ship It begins by introducing the common technical infrastructure that every project needs to get the ob done Readers can choose from a variety of recommended technologies according to their skills and budgets The next sections outline the necessary steps to get software out the door reliably using well accepted easy to adopt best of breed practices that really workFinally and most importantly Ship It presents common problems that teams face then offers real world advice on how to solve th. Environmental reuirements such as specific network drives4 Build automaticallyContinuous Integration You need to have tests in the system After all no one cares if it compiles if it doesn t runYou also need to turn on the notifications it make attention to the system when it is broken5 Track IssuesYou need to know the following What version of the product has the issue Which customer encountered the issue How severe is it Was the problem reproduced in house and by whom so they can help you if you re unable to reproduce the problem What was the customer s environment operating system database In what version of your product did the issue first occur In what version of your product was it fixed Who fixed it Who verified the fix6 Track FeaturesKeep a unified list of your feature reuests Prioritize them and keep a basic estimate of the time involved to investigate or add the feature7 Use a testing harnessA testing harness is the tool or software toolkit you use to create and run your tests If your tests aren t automated then you can t run them with a scriptUnless you want everyone on your team solving the same problems over and over constantly reinventing the wheel you should have a common framework everyone can use8 On Choosing ToolsUse the best tool for the Building the Cold War: Hilton International Hotels and Modern Architecture job Use open formats to integrate tools9 When not to ExperimentOnly experience can tell you about a given technology s shortcomings Pragmatic project techniues The List must adhere to a number of rulesPublicly availablePrioritizedOn a time lineLivingMeasurableTargeted The tech lead a person to be the interface between the development team and management The responsibilities of the Teach LeadSet direction for team membersManage the project s feature listAssign priorities to each featureInsulate the team from external distractions Daily meetings meet freuently with your entire team and let everyone share what they are doing How to get startedBe sure everyone knows the format which uestions you want answeredEveryone must answer the uestions There are no passes and no exceptionsAt first be lenient on the time restriction A lot of new information is exchanged in the beginning so you must allow communication to flow freelyHold your meetings at the same time and in the same place every day Make daily meetings a habit not a chore to keep track ofPost topics that are discussed during daily meetings on a web page or plogPick a person to start the meeting and then move clockwise through the group Our daily meetings last too long What do we do Draw team members away from the details of the fix and try toust get the summary For example instead of presenting a low level detailed analysis of the problem the debugging cycle and the final solytion ust say We had an issue with the cache not getting updating with the altered data It is now fixed and checked inYou can also ask team members to write down what they intend to share It will help them organize their thoughts before the meeting thus avoiding the rambling report that lasts for five minutesAnother potential problem is having too many people in the group In this scenario find a way to split the daily meetings into smaller groups when possible Put team members working in the same areas into the same meetings Be sure to have at least one or two people overlap so that relevant information can be passed along Code reviews iif a week goes by without a code review you ve allowed a lot of time for serious problems to creep into your code Small amount of code reviewedOne or two reviewers Firstly 1 senior 1 unior Don t need senior after 1 monthHappen freuentlyDon t publish code without a review Code change notificationsEmail and publish notificationsList the reviewer s nameList purpose of the code change or additionInclude the diff or file itself size permitting Burn rate a term that describes how much money it costs to operate the company including salaries rent electricity benefits Assume that each dev costs 100 an hour That means if you have 10 people on your team the ballpark burn
Rate Is 1000 An is 1000 an 8000 a day and 40000 a week The next time you have a meeting that
Starts 10 Minutes Late Or Everyone Hears 10 minutes late or everyone hears Fred s vacation for thirty minutes calculate the cost Rememer that this example ignores the cost of lost opportunities during the wasted time Bus number is the number of developers you d have to lose to disable your project key peopleTracer Bullet Development TBD automatically raises your bus your project key peopleTracer Bullet Development TBD automatically raises your bus When team members from adjacent layers work together to define their shared interfaces they are sharing knowledge about each layer s operations How to get started with TBDDefine your system objectsDefine the interfaces between themWrite the interface stubsMake the stubs talk with each otherFill in the stubs with functional code Ship ItBy Jared Richardson and William Gwaltney JrCopyright 2007Reviewed January 2008 by Anthony DeLucaI originally perceived Ship It to be different than it turned out I expected the book to be geared towards how to ship complex software suites that contained multiple products Perhaps it is because that was the information I was looking for at the time It turns out Ship It is a very basic book that gives a broad overview of modern grass roots based software development practices I describe the practices as grass roots practices as many of them were born from developer level open source collaborative efforts rather than from a large for profit organization seeking to make a profit with the content of the solutions as a mere means to this endSurprisingly my organization s teams practices many of the items in this book The book gives an excellent overview of each item and includes references to further information The book is broken down into tools and infrastructure pragmatic project techniues a single chapter on tracer bullet development and a great wrap up chapter about common problems and how to fix them In the end the appendix wraps the entire book into a very high level summary perfect as a reference with pointers to other places to go to get information or supporting tools Tools and Infrastructure touches on the many areas that developers talk about but only some practice Some items in this chapter would seem that no brainer common sense to modern developers yet a huge wake up call to developers who may not be as in touch with the industry The most compelling items in this section in my opinion are scripting builds and setting up an automated build The end of the section talks about tools and when NOT to experiment Pragmatic Programming Techniues talks about no brainer concepts that anyone who is in the agile world would certainly be aware The concepts in this section are light weight techniues that can be implemented with free or even no tools at all other than a white board and a desk calendar for each team member so they can know when they need to be in a meeting brief meeting to the point I feel that a large organization with multiple teams will need than this section offers but the information here is still an excellent baseline and a great foundation from which to buildThe Tracer Bullet Development section I found to be very enlightening since I had not known much about this in the past other than the name of the concept Tracer Bullet Development is the concept of building the entire system as templates of integrated pieces making that work then filling. Project moving Approaches to scheduling that work How to build developers as well as product What's normal on a project and what's not How to manage managers end users and sponsors Danger signs and how to fix them Few of the ideas presented here are controversial or extreme; most experienced programmers will agree that this stuff works Yet 50 to 70 percent of all project teams in the US aren't able to use even these simple well accepted practices effectively This book will help you get starte.