I looked at the manual + associated docs and found that they are very
thorough and strong improvement over the prior.
A few things I noted in my read through:
1. No mention of installation on Linux. There is a solid guide here
for 1.043:
http://www.cooldown.com.ar/2006/12/16/install-tracks-on-ubuntu-or-debian/
. Maybe it could be updated with the particulars of the 1.5 and a
link added to take users there? c00i90wn
<http://www.cooldown.com.ar/author/c00i90wn/> you out there? The
best would be to package it as a .deb or .rpm and then it would be
a snap.
2. in the section for upgrading the 1.043 database to 1.5, I think it
could be more explicit that this is to take a 1.043 database to
1.5. I mentions it in the section above that links to here, but if
the user did not come from there, they might not have seen it.
Here: /tracks/doc/manual.html#rake_upgrade
3. The manual should make mention that the application support mobile
access for installations accessible from the internet. The URL is
http://yourdomain.com/mobile/ . Also, it would be good to show
some information on the applications preferences page as to what
the link is. Better mobilizing this app could be a powerful growth
area for the project.
4. One area that I think we could grow this documentation area into
is user instruction. The best might be if we put together a video
tutorial or two. It could walk the user through adding a couple
actions, projects and contexts etc. The great part of tracks is it
does need much in instruction, but it might put new users at ease
and speed adoption. Does anyone know of any good screen capture
software (open source hopefully :) that would be need for the
video part?
That's it.
Thanks!
Tim
[EMAIL PROTECTED] wrote:
I'm trying to organise the documentation for the release of Tracks
1.5. So far, I've updated the installation instructions in /doc.
There's a manual in HTML and PDF format, both generated automatically
using multimarkdown from manual.tex. That directory also includes a
changelog for Tracks, and a readme file - README_FOR_APP. Currently,
that file duplicates what is now in the manual, so I'm proposing to
move a very cut-down readme to the root of the tracks directory to
point people to the /doc directory for the installation manual and
changelog.
In the root directory, we also have:
* CHANGELOG (for Rails, but seemingly very outdated)
* CHANGELOG_TRACKS which points to the real changelog in /doc
* README_DEVELOPERS (info on SQLite3 for testing and selenium)
* README_RAILS (general info on Rails)
* installation.html (the old installation instructions)
This all seems a bit confusing and disorganising, so what I'm
proposing is this:
* Delete /installation.html (duplicated by new manual.html)
* Delete /CHANGELOG
* Add /README_FIRST to point users to /doc directory for manual and
changelog
* Delete CHANGELOG_TRACKS (see point above)
* Move README_DEVELOPERS to /doc
* Move README_RAILS to /vendor/rails and include a link pointing to it
in README_FIRST for those wanting more general information about Rails
What do people think? Also, if anyone has a few minutes to look
through the new manual, please do, and let me know if you find any
errors or things that need adding.
cheers,
bsag
_______________________________________________
Tracks-discuss mailing list
[email protected]
http://lists.rousette.org.uk/mailman/listinfo/tracks-discuss
