Difference between revisions of "Pcsvnrelease"

From ProgClub
Jump to: navigation, search
(Web Design Tips for Online Casino Sites)
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
Expert Usability Review vs Usability Testing
+
Pcsvnrelease is the ProgClub project release script. That's the software that helps us manage versioned releases of our projects as specified on the [[versions]] page. For other projects see [[projects]].
−
+
 
−
1 question we're often asked will be which method is truly best: usability testing or expert usability reviews? Well, when they were sports cars, expert usability reviews might be considered a Porsche (very decent car and better than no car at all), but usability testing would end up being in a different league, namely Formula 1.  
+
= Status =
−
+
 
−
So, what'ersus the difference?
+
Under way. Not released yet, there's stuff [[#TODO|TODO]].
−
+
 
−
- The expert usability review will be when a usability specialist inspects a web site to identify potential usability troubles
+
= Administration =
−
+
 
−
- Usability testing involves getting people through the target audience to evaluate your site whilst performing tasks
+
== Contributors ==
−
+
 
−
These people're quite comparable in many ways in that both:  
+
Members who have contributed to this project. Newest on top.
−
+
 
−
- Find and prioritise usability symptoms
+
* [[User:John|John]]
−
+
 
−
- Evaluate designs in the context of tasks
+
All contributors have agreed to the terms of the [[ProgClub:Copyrights#ProgClub_projects|Contributor License Agreement]]. This excludes any upstream contributors who tend to have different administrative frameworks.
−
+
 
−
Perform that they discover the same troubles?
+
Upstream contributors:
−
+
 
−
The answer depends on just how precisely you measure this kind of, on balance no, not reliably. In most cases, expert usability reviews tend to discover high level breaches of design rules and consistency. Usability testing is truly better at finding issues related to special domain knowledge and task flows.  
+
* TBA
−
+
 
−
Had you been to transport out a helpful expert usability review before conducting usability testing, and compare both sets of findings, you can see how the issues you found when compared with their real experiences. Did you locate every single one the symptoms? Which versions did you pass up? Which ones that you thought might be issues flipped out not to always be? This particular will provide you a good feel for how expert usability reviews keep up versus usability testing.  
+
== Copyright ==
−
+
 
−
Often, expert reviews will:
+
Copyright 2012, [[#Contributors|Contributors]].
−
+
 
−
- Ignore usability issues that arise during usability testing
+
== License ==
−
+
 
−
- Find some issues that usability testing didn't
+
Licensed under the [[New BSD license|New BSD]] license.
−
+
 
−
- Report false alarms (i.ourite. not real issues)
+
= Resources =
−
+
 
−
Understanding that'utes the problem. Irrespective of how good a very expert you are if you just count on an expert usability review you'll find different types of issues and overlook some potentially serious ones.  
+
== Source code ==
−
+
 
−
Consider the case of a health website aimed specifically at fresh mums. The expert usability review found plenty of great issues, but might have missed the main killer the one that caused participants to pass comments like "That'ersus just so insensitive!" and "I wouldn'big t use this website anymore". And a lot of because of a seemingly benign bit of banner advertising for a the nearest health club placed next to a helpful article about bust serving. A reviewer would have difficulty predicting the indignant reaction of brand-new mothers who felt the site ended up being rubbing their nose in it. All things considered there would be little possibility of them going anywhere near a health club with a newborn.
+
The repository can be browsed online:
−
   
+
 
−
How much overlap can there be between expert usability reviews & usability testing?
+
https://www.progclub.org/pcrepo/pcsvnrelease
−
+
 
−
Naturally, there is actually some overlap in the issues within both expert usability reviews and usability testing. Research performed by Fu, Salvendy and Turley in 2002 estimated it to become surrounding 41%. Not like high like you might expect. Interestingly, expert usability reviews tend to come across much more symptoms inside comparison to usability testing. But it's high quality over quantity.  
+
The latest stable released version of the code is available from:
−
+
 
−
Expert usability reviews are good...  
+
https://www.progclub.org/svn/pcrepo/pcsvnrelease/tags/latest
−
+
 
−
Expert usability reviews are more common than usability testing basically because these people're more affordable and quicker to carry out. Typically, it'll only have a few times to inspect a site and write a report and because you don'capital t need to retain the services of labs nor recruit consumers, charges are significantly more affordable. For this reason, that they're often preferred to usability testing, certain when time and budget are squeezed.
+
Or if you want the latest version for development purposes:
−
+
 
−
There are nonetheless some pitfalls. For a start, a lot depends on the reviewer'ersus level of experience. No two usability experts will locate exactly the same issues so the method will be also available to practitioner variation. The largest problem nonetheless will be merely that they will sometimes ignore the real problems that cause consumers to fail tasks. This kind of may be especially true if the audience provides a particular skill set. For case in point, a great accountant may always be better placed to diagnose particular types of issues related to online accountancy tasks than a non-accountant reviewer.
+
svn://www.progclub.org/svn/pcrepo/pcsvnrelease/trunk
−
   
+
 
−
...But usability testing is truly da Daddy!
+
== Links ==
−
+
 
−
Usability testing takes more time to arrange and organise and will be a lot more expensive way too - recruiting and incentivising people coming from a customers may be costly. But it's definitely worth the effort! The outcome provide a truer picture with the real symptoms people encounter because that they're derived from real people in the first place.  
+
* [[Versions]], for information about the ProgClub version number system.
−
+
 
−
It's inconceivable how sites go live without checking to see that they will're actually usable. It's like building a vehicle but not test driving it. "Indeed, we've built this specific great website. Umm, well no, we've not looked at to find out if people can apply it yet. But don'n worry because a lot of the links function and the pages download quickly."
+
= Specifications =
−
+
 
−
Another advantage of usability testing will be that there'ersus much less conjecture and feedback comes straight through the horse'utes mouth. Vids of user sessions in particular, offers a powerful persuasion device for reluctant stakeholders. It's hard to argue with recordings of people in tears of frustration.
+
== Functional specification ==
−
+
 
−
Use real users and accept no substitute!
+
=== Standard /etc scripts ===
−
+
 
−
Both expert usability reviews and usability testing have their time and place. In exercise, people often use expert usability reviews early on straighten upward their design in arrangements for usability testing. (Indeed that is critical for accessibility testing, since it's a waste of time to recruit and test consumers who can'big t even get into your site in the first place.)
+
Within a branch there might be an /etc folder, and in /etc might be a 'test' or 'set-version' script as standard.
−
+
 
−
Whilst a great expert usability review is actually better than nothing, it'ersus still vital to apply your internet site in front of customers when early while it can be also, instead than leaving it as well late. Key elements this kind of like site structure and navigation should be assessed with subscribers at the first opportunity. Otherwise you risk having your website considerably overhauled at a late stage.  
+
==== /etc/test ====
−
   
+
 
−
Ultimately, the key would be to appreciate that expert usability reviews and usability testing are different beasts. The most efficient approach is to try and integrate both techniques. Remember though, you must test your site with real people - accept no substitute!
+
The 'test' script, if it exists, will be executed by pcsvnrelease before beginning a release to confirm that the software is fit for release. If the 'test' script exits with a non-zero error level the release is aborted because crucial tests have failed.
−
http://tblol.com/index.php/member/60123/
+
 
 +
==== /etc/set-version ====
 +
 
 +
The 'set-version' script, if it exists, will be called by pcsvnrelease after the VERSION* and RELEASE files have been updated so that if the project version number needs to be copied in to other files before a release the 'set-version' script can take care of that if necessary.
 +
 
 +
=== SUBPROJECTS file ===
 +
 
 +
The SUBPROJECTS file lives in the branch root and lists the projects that are managed as subprojects and released in conjunction with the main project. The format of the SUBPROJECTS file is:
 +
 
 +
  externals_path subproject_path subproject_url subproject_branch
 +
 
 +
For example, the 'slib' project might be included as a subproject with an entry in the SUBPROJECTS file like this:
 +
 
 +
lib/slib slib svn://www.progclub.org/svn/pcrepo/slib /trunk
 +
 
 +
Or if you wanted to use the latest maintenance release of version 1 of slib and ignore newer major versions:
 +
 
 +
lib/slib slib svn://www.progclub.org/svn/pcrepo/slib /branches/version/1
 +
 
 +
Note: when subprojects are released they are always minor releases even if the main project is having a major release.
 +
 
 +
Any svn:externals definitions that are defined on a project's subfolders that aren't listed in the SUBPROJECTS file don't get treated as subprojects and released but they do get set to a specific revision (with a revision and peg revision both set to the revision the repository is at at the time of the release). So if you didn't want to manage slib as a subproject but rather wanted to use a specific release of slib you could just define the svn:externals for slib to point at:
 +
 
 +
svn://www.progclub.org/svn/pcrepo/slib/tags/version/1/4
 +
 
 +
Or:
 +
 
 +
svn://www.progclub.org/svn/pcrepo/slib/tags/release/2012/03/15/001
 +
 
 +
Or if you just wanted to use the latest release (but not manage slib as a subproject) you could specify an svn:externals of:
 +
 
 +
svn://www.progclub.org/svn/pcrepo/slib/tags/latest
 +
 
 +
=== Minor release ===
 +
 
 +
To do a typical minor release of the pcsvnrelease project:
 +
 
 +
  $ pcsvnrelease minor svn://www.progclub.org/svn/pcrepo/pcsvnrelease /trunk
 +
 
 +
Or to release a specific branch (e.g. the version 1 branch) of the pcsvnrelease project:
 +
 
 +
$ pcsvnrelease minor svn://www.progclub.org/svn/pcrepo/pcsvnrelease /branches/version/1
 +
 
 +
=== Major release ===
 +
 
 +
To do a typical major release of the pcsvnrelease project:
 +
 
 +
$ pcsvnrelease major svn://www.progclub.org/svn/pcrepo/pcsvnrelease /trunk
 +
 
 +
Or to release a specific branch (e.g. the version 1 branch) of the pcsvnrelease project:
 +
 
 +
$ pcsvnrelease major svn://www.progclub.org/svn/pcrepo/pcsvnrelease /branches/version/1
 +
 
 +
== Technical specification ==
 +
 
 +
Pcsvnrelease is implemented as a BASH script that uses the svn command-line utility to manipulate the repository.
 +
 
 +
= Tasks =
 +
 
 +
== TODO ==
 +
 
 +
Things to do, in rough order of priority:
 +
 
 +
* Implement minor releases
 +
* Implement major releases
 +
 
 +
== Done ==
 +
 
 +
Stuff that's done. Latest stuff on top.
 +
 
 +
* [[User:John|JE]] 2012-03-15: created project in svn with prototype release script and test repos.
 +
* [[User:John|JE]] 2012-03-15: created project page.
 +
 
 +
= Notes =
 +
 
 +
== Notes for implementers ==
 +
 
 +
If you are interested in incorporating this software into your project, here's what you need to know:
 +
 
 +
Just copy and paste your way to victory, this script is pretty much stand-alone.
 +
 
 +
== Notes for developers ==
 +
 
 +
If you're looking to set up a development environment for this project here's what you need to know:
 +
 
 +
There are testing repositories at:
 +
 
 +
* svn://www.progclub.org/svn/pctestrepo-a
 +
* svn://www.progclub.org/svn/pctestrepo-b
 +
 
 +
Those repositories have been setup with projects and dependencies so that you can test the release script on the 'testproj-a' project like this:
 +
 
 +
$ pcsvnrelease minor svn://www.progclub.org/svn/pctestrepo-a/testproj-a trunk
 +
$ pcsvnrelease major svn://www.progclub.org/svn/pctestrepo-a/testproj-a trunk
 +
  $ pcsvnrelease minor svn://www.progclub.org/svn/pctestrepo-a/testproj-a branches/version/1
 +
$ pcsvnrelease major svn://www.progclub.org/svn/pctestrepo-a/testproj-a branches/version/1
 +
 
 +
When you release 'testproj-a' from 'pctestrepo-a' it should trigger a sub-release of 'testproj-b' from 'pctestrepo-b' and 'testproj-c' from 'pctestrepo-a'.

Latest revision as of 15:17, 11 December 2017

Pcsvnrelease is the ProgClub project release script. That's the software that helps us manage versioned releases of our projects as specified on the versions page. For other projects see projects.

Status

Under way. Not released yet, there's stuff TODO.

Administration

Contributors

Members who have contributed to this project. Newest on top.

All contributors have agreed to the terms of the Contributor License Agreement. This excludes any upstream contributors who tend to have different administrative frameworks.

Upstream contributors:

  • TBA

Copyright

Copyright 2012, Contributors.

License

Licensed under the New BSD license.

Resources

Source code

The repository can be browsed online: 

https://www.progclub.org/pcrepo/pcsvnrelease

The latest stable released version of the code is available from: 

https://www.progclub.org/svn/pcrepo/pcsvnrelease/tags/latest

Or if you want the latest version for development purposes: 

svn://www.progclub.org/svn/pcrepo/pcsvnrelease/trunk

Links

  • Versions, for information about the ProgClub version number system.

Specifications

Functional specification

Standard /etc scripts

Within a branch there might be an /etc folder, and in /etc might be a 'test' or 'set-version' script as standard.

/etc/test

The 'test' script, if it exists, will be executed by pcsvnrelease before beginning a release to confirm that the software is fit for release. If the 'test' script exits with a non-zero error level the release is aborted because crucial tests have failed.

/etc/set-version

The 'set-version' script, if it exists, will be called by pcsvnrelease after the VERSION* and RELEASE files have been updated so that if the project version number needs to be copied in to other files before a release the 'set-version' script can take care of that if necessary.

SUBPROJECTS file

The SUBPROJECTS file lives in the branch root and lists the projects that are managed as subprojects and released in conjunction with the main project. The format of the SUBPROJECTS file is: 

externals_path subproject_path subproject_url subproject_branch

For example, the 'slib' project might be included as a subproject with an entry in the SUBPROJECTS file like this: 

lib/slib slib svn://www.progclub.org/svn/pcrepo/slib /trunk

Or if you wanted to use the latest maintenance release of version 1 of slib and ignore newer major versions: 

lib/slib slib svn://www.progclub.org/svn/pcrepo/slib /branches/version/1

Note: when subprojects are released they are always minor releases even if the main project is having a major release.

Any svn:externals definitions that are defined on a project's subfolders that aren't listed in the SUBPROJECTS file don't get treated as subprojects and released but they do get set to a specific revision (with a revision and peg revision both set to the revision the repository is at at the time of the release). So if you didn't want to manage slib as a subproject but rather wanted to use a specific release of slib you could just define the svn:externals for slib to point at: 

svn://www.progclub.org/svn/pcrepo/slib/tags/version/1/4

Or: 

svn://www.progclub.org/svn/pcrepo/slib/tags/release/2012/03/15/001

Or if you just wanted to use the latest release (but not manage slib as a subproject) you could specify an svn:externals of: 

svn://www.progclub.org/svn/pcrepo/slib/tags/latest

Minor release

To do a typical minor release of the pcsvnrelease project: 

$ pcsvnrelease minor svn://www.progclub.org/svn/pcrepo/pcsvnrelease /trunk

Or to release a specific branch (e.g. the version 1 branch) of the pcsvnrelease project: 

$ pcsvnrelease minor svn://www.progclub.org/svn/pcrepo/pcsvnrelease /branches/version/1

Major release

To do a typical major release of the pcsvnrelease project: 

$ pcsvnrelease major svn://www.progclub.org/svn/pcrepo/pcsvnrelease /trunk

Or to release a specific branch (e.g. the version 1 branch) of the pcsvnrelease project: 

$ pcsvnrelease major svn://www.progclub.org/svn/pcrepo/pcsvnrelease /branches/version/1

Technical specification

Pcsvnrelease is implemented as a BASH script that uses the svn command-line utility to manipulate the repository.

Tasks

TODO

Things to do, in rough order of priority:

  • Implement minor releases
  • Implement major releases

Done

Stuff that's done. Latest stuff on top.

  • JE 2012-03-15: created project in svn with prototype release script and test repos.
  • JE 2012-03-15: created project page.

Notes

Notes for implementers

If you are interested in incorporating this software into your project, here's what you need to know:

Just copy and paste your way to victory, this script is pretty much stand-alone.

Notes for developers

If you're looking to set up a development environment for this project here's what you need to know:

There are testing repositories at:

Those repositories have been setup with projects and dependencies so that you can test the release script on the 'testproj-a' project like this: 

$ pcsvnrelease minor svn://www.progclub.org/svn/pctestrepo-a/testproj-a trunk
$ pcsvnrelease major svn://www.progclub.org/svn/pctestrepo-a/testproj-a trunk
$ pcsvnrelease minor svn://www.progclub.org/svn/pctestrepo-a/testproj-a branches/version/1
$ pcsvnrelease major svn://www.progclub.org/svn/pctestrepo-a/testproj-a branches/version/1

When you release 'testproj-a' from 'pctestrepo-a' it should trigger a sub-release of 'testproj-b' from 'pctestrepo-b' and 'testproj-c' from 'pctestrepo-a'.

Retrieved from "https://www.progclub.org/wiki/mediawiki/index.php?title=Pcsvnrelease&oldid=4862"