I would consider documenting these in a TDD/BDD language/tool
For example in Cucumber (which now works in something like 50+, languages)
$ sudo apt-get install cucumber #(ubuntu)
$ mkdir some_test
$ cd some_test
$ cucumber init
Now create the file features/some_thing.feature
Feature: weekend check
Everybody wants to know when it's the weekend
Scenario: Sunday isn't Friday
Given Sunday
When I ask
Then I am told "Nope"
Then you can run cucumber:
$ cucumber features/is_it_friday_yet.feature
Feature: Is it Friday yet?
Everybody wants to know when it's Friday
Scenario: Sunday isn't Friday # features/is_it_friday_yet.feature:4
Given Sunday # features/is_it_friday_yet.feature:5
When I ask whether it's Friday yet # features/is_it_friday_yet.feature:6
Then I am told "Nope" # features/is_it_friday_yet.feature:7
1 scenario (1 undefined)
3 steps (3 undefined)
0m0.013s
You can implement step definitions for undefined steps with these snippets:
Given(/^Sunday$/) do
pending # Write code here that turns the phrase above into concrete actions
end
When(/^I ask whether it's Friday yet$/) do
pending # Write code here that turns the phrase above into concrete actions
end
Then(/^I am told "nope"$/) do |arg1|
pending # Write code here that turns the phrase above into concrete actions
end
So you follow the instructions and create the above in a file in features/step_definitions/some_thing_steps.rb
Then you work on the code to get the specs passing
Another example, with ruby and rspec:
rspec has a really neat and short way of setting up the things to test:
Here are 4 tests that need to be implemented
require 'rspec'
describe "this is the basic tests" do
it "logging in"
it "going to member page"
it "updating my profile"
it "changing my email"
end
When you run this you'll get pending specs to implement
$ rspec pending_spec_exanple_spec.rb
****
Pending: (Failures listed here are expected and do not affect your suite's status)
1) This is the basic tests logging in
# Not yet implemented
# ./pending_spec_exanple_spec.rb:4
2) This is the basic tests going to member page
# Not yet implemented
# ./pending_spec_exanple_spec.rb:5
3) This is the basic tests updating my profile
# Not yet implemented
# ./pending_spec_exanple_spec.rb:6
4) This is the basic tests changing my email
# Not yet implemented
# ./pending_spec_exanple_spec.rb:7
instead of the dreaded excel, email, text doc, etc. use real tests!
Note: rspec is free open source software