(Free) Ship it! A Practical Guide to Successful Software Projects BY Jared Richardson

free read Ship it! A Practical Guide to Successful Software Projects

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 a 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 just 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 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 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 to just get the summary For example instead of presenting a low level detailed analysis of the problem the debugging cycle and the final solytion just 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 junior 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 hour 8000 a day and 40000 a week The next time you have a meeting that starts 10 minutes late or everyone hears about 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 number 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

free download õ PDF, DOC, TXT or eBook ã Jared Richardson

Ship it! A Practical Guide to Successful Software Projects

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 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 just 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 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 process jars 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 In 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 are 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 application3 Performance Testing Testing the application to ensure that the application is performing within acceptable limits and meets the SLAs4 Load Testing This is similar to the Performance Testing The goal of this is to ensure that the application does not collapse under load5 Smoke Testing This is a light weight testing which will test the key functionality of the application This should be included as part of Continuous Integration so that any breakage in key functionality comes to light very uickly6 Integration Testing This ensures that the integration of the modules within the application and the integration of the application with the external systems is functioning correctly7 Mock Client Testing This mocks the client reuests and ensures that the client get the right response and within the expected time periodPragmatic Project Techniues Some of the good practices to follow when working in projects are as follows1 Maintaining a list of activities to do This should be visible and accessible to everybody on the project Even the client should have visibility to the list so that they are check the speed and prioritize the items in the list Each item should have a target time The list should reflect the current status and should not be out of date2 Having Tech Leads in the project is important The Tech lead should guide the team in the selection and utilization of the technology Tech lead should be responsible to ensure that the deadlines are realistic The Tech lead should act as the bridge between the developers and the management It is an important role to be played by a person with the right temperament3 Coordinating and Communicating on daily basis is very important Meetings need to be setup on a daily basis These meetings should be short and to the point with everybody sharing details of what they are doing and what they plan to do Team should highlight any problem they are facing The solutions for these problems should not be part of this meeting but should happen separately4 Code review is a very crucial part of the project and every piece of code should be reviewed Some good practices of code review are a Review only a small amount of code at any time b A code should not be reviewed by than two people c Code should be reviewed freuently possibly several times a day d Consider pair programming as a continuous code review processTracer Bullet Development Just like it is possible to fire a Tracer Bullet in the night to track the path before aiming the real bullet it should be possible to predict the path of the project using the process opted forHave a process to followThe process followed should not claim exclusivity in success of projects If it does so then suspect itFollow a process that embraces periodic reevaluation and inclusion of whatever practices work well for the projectsDefine the layers that will exist in the applicationDefine the interfaces between the layersLet each layer be developed by a separate team relying on the interface promised by the adjacent layersKeep it flexible so that the interface can be changed as it is hard to get the interfaces perfect the first time aroundFirst create the large classes like the Database Connection Manager Log Manager etc reuired for each layer then write the fine grained classesCollaboration between the teams developing the different layers is key to the success These collaborations will Trace the Path that the project will takeDo not let an architect sitting in an ivory tower dictate the architectureIt is dangerous to have one person driving the whole project If this person leaves the project will come to a standstillCreate stubs or mock the interfaces of the adjacent layers so that it becomes easy to testCode the tough and key pieces first and test them before addressing the simpler ones It may take time to show progress but when the progress happens it will be very uickCommon Problems and How to fix Them What to do when legacy code is inherited1 Build it Learn to build it and script the build2 Automated it Automate the build3 Test it Test to understand what the system does and write automated test casesDon t change legacy code unless you can test it1 If a code is found unsuitable for automated test then refactor the code slowly so that it becomes amenable to automated testing2 If a project keeps breaking repeatedly automated test cases emulating the user actions will help reduce the incidents3 Ensure that the automated tests are updated with change in codelogic whenever reuired otherwise these would become useless4 It is important to have a Continuous Intergration so that the automated tests can be run regularly5 Early checkins in fact daily or than once a day and uick updates by the developers is important so that the integration problems are detected as early as possible6 It is important to communicating with the customers and getting regular feedback7 Best way to show the customer the progress of the project is to show them a working demo of the application8 Introduce a process change when the team is not under pressure Point out the benefit the stakeholders will have with the new process Show them the benefit of the processpractice rather than talk and preach about itA wonderful uote from the bookI love deadlines I especially love the swooshing sound they make as they go flying by Scott Adams

Jared Richardson ã 0 free read

D Ship It begins by introducing the common technical infrastructure that every project needs to get the job 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 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


10 thoughts on “Ship it! A Practical Guide to Successful Software Projects

  1. says:

    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

  2. says:

    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 the authors prescribe techiues that are not always appropriateThe book covers thre

  3. says:

    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 just 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

  4. says:

    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 i

  5. says:

    Practical handbook that help team to move from dark side to light and become a jedi 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

  6. says:

    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 just because it is popular or well known or is practised by others

  7. says:

    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 ve

  8. says:

    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

  9. says:

    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

  10. says:

    Ship ItBy Jared Richardson and William Gwaltney JrCopyright 2007Reviewed January 2008 by Anthony DeLucaI originally perceived Ship It to be dif