HELP suggestions - What's New page

May 20, 2008
3,515
4
Elkridge, MD, USA
Once each change is fully documented, you can drop the syntax of new or enhanced features from the What's New page - unnecessary duplication; you already make it a link to the full documentation.

OTOH, in-page links from its top, or even from the title bar, to its major sections (possibly even before release, by using a prototype page) would speed up its usage. The "Conditional Expressions" page is a good example of the former, "Ranges" of the latter.
--
Steve
 

rconn

Administrator
Staff member
May 14, 2008
12,364
150
Once each change is fully documented, you can drop the syntax of new or enhanced features from the What's New page - unnecessary duplication; you already make it a link to the full documentation.

That's not really feasible -- the "What's New" section is linked from a lot of different places, including forum announcement messages, the JP Software web site, the JP Software newsletters, and several hundred third-party web sites. Removing most of the information there would irritate users and make finding the information a lot more tedious.

I'd need to create *two* "What's New" pages -- one that is displayed when in the help file, and a different one that is displayed when referenced from somewhere else. That seems like a lot of trouble to save 1 or 2K of file size.
 
May 20, 2008
3,515
4
Elkridge, MD, USA
From: rconn
| Originally Posted by Steve Fabian
|| Once each change is fully documented, you can drop the syntax of new
|| or enhanced features from the What's New page - unnecessary
|| duplication; you already make it a link to the full documentation.
|
| That's not really feasible -- the "What's New" section is linked from
| a lot of different places, including forum announcement messages, the
| JP Software web site, the JP Software newsletters, and several
| hundred third-party web sites. Removing most of the information there
| would irritate users and make finding the information a lot more
| tedious.
|
| I'd need to create *two* "What's New" pages -- one that is displayed
| when in the help file, and a different one that is displayed when
| referenced from somewhere else. That seems like a lot of trouble to
| save 1 or 2K of file size.


Ah! Since I've been using your products so long I never look elsewhere but the email from the forum and the HELP file. I was not aware that this page has so many links. Though I fail to see why anyone would look for the exact syntax of new features on the web, instead of their local HELP file, esp. searching through 3-rd party web sites. If they do not have the product, what difference does the syntax make? Barring the occasional user who is editing a batch file when at a location without the installed HELP... But they could not test their work!
--
Steve
 

rconn

Administrator
Staff member
May 14, 2008
12,364
150
>Though I fail to see why anyone would look for the exact
> syntax of new features on the web, instead of their local
> HELP file, esp. searching through 3-rd party web sites.

That's not what I'm referring to.

The newsletter and third-party web sites / blogs are saying things like
"Take Command v13 has been released; click here for details on the new
features." If that takes you to a page that only says "COPY and DEL and DIR
etc. etc. have been enhanced, click on these other 300 links to get
individual details, most of which you're not going to care about", it's not
going to inspire you to browse much further.
 
Similar threads
Thread starter Title Forum Replies Date
C Add link to ewriter help to program group... Support 3
samintz How to? Search for %(command) in Help? Support 1
Joe Caverly Favorites in eWriter Help Support 6
Joe Caverly Quick Search in eWriter Help Support 1
vefatica Online help? Support 2
fishman@panix.com HELP!! I just updated to Version 28 and as usual I cannot make extended directory search work. Support 2
JohnQSmith New online help file wrong logo Support 7
Jay Sage Documentation Function @DRIVE Missing in Help Lists Support 0
Charles Dye More help nits Support 0
D Documentation Typo in COPY help Support 0
FreezerBurnt Help making a CMD and TCC compatible batch file Support 7
Joe Caverly Documentation COMMANDS in Version 27 help Support 8
K_Meinhard How to? Help window position Support 7
U Command help on file names Support 5
D Documentation Help "Startup" page does not describe global lists Support 0
vefatica Help disappears? Support 6
rchapmanitt Help Purchasing Support 2
Charles Dye Documentation Help nits: @ZIPFILECRC Support 0
C version help Support 3
C Documentation Help Nit. REN / RENAME Support 0
Dmitry L. Kobyakov Documentation Error in the Help: the WINDOW command Support 0
vefatica Help for @PID Support 2
vefatica Need help with XML Support 3
Alpengreis Documentation Minor issue in help file for view /E Support 1
R Documentation Advanced Directives Help Support 0
R Documentation Help Nit with SETP Support 0
R wmic command help Support 9
R Documentation Help Nit > bdebugger View Menu Support 0
R Documentation A couple of Help nits Support 0
R Documentation Help typo Support 1
MikeBaas How to? I need help with RD Support 5
R Documentation v25 Help Comments Support 1
Joe Caverly DIRectory Colorization in v25 Help File Support 0
vefatica Help nit Support 0
D error in help documentation? Support 0
Joe Caverly _EXPANSION in help file Support 0
K_Meinhard Help file error Support 1
Joe Caverly JOBMONITOR in Help File Support 1
A Documentation [Help file] OPTION "//" synopsis formatting issue Support 0
D The local HELP viewer... Support 0
Chen Touboul Overtyping issue - i press the Insert key, help till press enter for new line in TCC Support 2
C Documentation Help nix ZIP /M Support 0
Joe Caverly v24 Help File - DATEMONITOR Support 1
Joe Caverly 7zip command links to zip help Support 0
K_Meinhard Help problems Support 3
Charles Dye Documentation Help Nits Forever: Checksum functions Support 0
Joe Caverly SAVECONSOLE in Help File Support 0
Joe Caverly CMDebug v23 Help: /FEEDBACK /UPDATE Support 0
Joe Caverly CMDebug v23 Help: Link to MOUNTVHD goes to MOUNTISO in UNMOUNTVHD Support 0
Joe Caverly Help not launching in CMDebug v23.00.14 x64 Support 1

Similar threads