Agile Development Methodology for
Building Rails App
We write down a list of goals, roles, and features
- Goals – what the goals of the whole project are – business and otherwise. This will help you decide what features are important
- Roles – who is going to use the site – visitors, logged in members, admins? Do different people have different views of the same information on the site?
- Features – what are the basic categories of interaction on the site? For example: Users: registration, using the forums, and blogging; Admins: moderating the user content
We write a list of stories
- A story is different than a feature because it represents a single thread of interaction from a particular user’s perspective.
- It’s common to express stories in form “As a ____ I want to ____ so that I can _____.” This forces you answer three important questions – Who is this for? What do they want to do? Why do they want to do it?
- If you can’t complete a story in this form, it’s likely that you don’t have an answer to one of these three questions yet, so you’ll need to do some thinking to get the answers before the story is actionable.
- Ex: “As an admin, I want to ban users from the forum, So that I can improve the quality of user-submitted content on the site.
- Write these stories down on notecards. This will help you in estimation and prioritization.
We estimate the stories
- Estimation is a huge topic in itself, but the basic idea is to associate a particular level of effort with each story.
- The most common scales are 0/1/2/3/4, 0/1/2/4/8. I don’t think this is incredibly important, but pick something and stick with it.
- Don’t get too hung up on the exactness of the estimates. Lots of things affect how long it takes you to finish a story, so small differences in story complexity tend to get lost in the noise.
- Your goal here is to differentiate things that are low in effort, like stories that will result in you creating a simple model with a REST controller, from stories that are high in effort, like interfacing your application with a challenging third-party API, or a story that will require you to use a technology you aren’t very familiar with.
- Write the estimate on each card.
We prioritize the stories
- Rearrange the cards in the order that you’d like to tackle the stories.
- Only the product owner can really make this decision. There are a lot of things that go into prioritization – deadlines, user testing, business value, etc. Estimation may have a lot to do with prioritization, because it illuminates opportunity cost. Maybe the product owner really wants that detailed Admin Dashboard, but if all the stories to make that work total 40 points, is it worth it to spend a month on just this feature. Maybe the product owner still wants the story
- Are there any stories that don’t fit into the very minimum viable product to launch? If so, you should move them down. Try to complete a functioning app as quickly as possible so you can put it in front of users.
- At this point, I usually move my cards into Pivotal Tracker, but I know lots of people who prefer pen and paper.
We test-drive the first story to completion
- Begin with Cucumber Write a Cucumber feature that covers the user’s interaction with the site from beginning to end. Define the undefined steps as you come to them, and when you hit your first failure, you know that there’s a behavior that you desire that your app doesn’t have (This will happen very quickly at first, because your blank app doesn’t have much behavior).
- Continue to Rspec Write the test for the behavior you wish you had.
- Write your code Write the code to make the spec pass. This is going to take you throughout your application from routing to UI, to models, to the database schema, to the controller. You will tackle these pieces of code in the order your tests direct you to.
- Repeat until the Cucumber passes, and you’re done with the story.
- Now is a good time to fix up the CSS styling assuming you have the design done. If I’m working alone or without a designer, I like to try to wireframe the UI either on paper or in something like Balsamiq Mockups before I even start coding the story.
We accept the story
- Is the story acceptable? Does it do what you wanted it to? If not, you need to go back and make it work the way it was supposed to. Writing Cucumber tests in advance helps prevent this from happening.
- Do all your tests pass? You didn’t break the build, did you? If so, you need to fix what you broke.
- If you’re working alone, it may be helpful to have someone else do acceptance for you, as it may be hard to see your own work with objective eyes.
We repeat until done
This is how I do things. It’s by no means the only way to do things, but it is a very common way to do things in Rails. I think there’s a good debate to be had around the value of agile estimation, or of particular technologies like Cucumber vs. Steak or RSpec vs Test::Unit, but most Rails developers will agree that the proper workflow is to:
1) Identify a single story
2) Write tests for it
3) Complete it.