1. Is the manual intended to be self-contained, or does it assume familiarity with Hg? I suspect the answer is the latter, although 1.1 only mentions an assumed familiarity with Windows explorer and the reading guide 1.2 does not include any references to Hg proper.
A self-contained document would be ideal; failing that some reference to Hg docs would be good. Some of my confusion, for example which files are in a manifest and whether a revision includes all files, probably reflects my relative ignorance of Hg. Ditto for an understanding of branching and merging. 2. Program vs task-based documentation. Much of the manual is program based: if you click here you will get this menu, which does these things. As noted in my message on the specifics, sometimes "these things" aren't described well or at all. A task-based approach is often more helpful, especially for novices. 5.5-5.13 and 7 tend in that direction. However, the task-based information tends to focus on Hg-specific repository-level operations. The more vanilla version control tasks involved with the standard work cycle while working on a project, are not there: add, remove, delete or editing files and directories. commit is there. The specific task that got me into this, wanting to revert a file to a previous version, is not there (I know: probably the revert command; I wasn't sure if that operated on the repository or what its implications were for branching). I didn't see a discussion of branching and merging. 3. Redundancy The same function is accessible in multiple ways, often from multiple context menus, some regular menus, and some toolbars. In the detail email I said it would be helpful to have detailed descriptions after the context menus. The problem is that detailed descriptions could also go elsewhere--and probably are often elsewhere, if I had hunted around enough. Perhaps there should be one spot with the commands fully documented and links to it from the appropriate places. Ross ------------------------------------------------------------------------------ Got visibility? Most devs has no idea what their production app looks like. Find out how fast your code is with AppDynamics Lite. http://ad.doubleclick.net/clk;262219671;13503038;y? http://info.appdynamics.com/FreeJavaPerformanceDownload.html _______________________________________________ Tortoisehg-discuss mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/tortoisehg-discuss
