[personal profile] tamaranth
I'm trying to come up with a symbol / icon to indicate that information in a paragraph applies only to the current version / differs in previous versions / has changed. Have considered and discarded 'pencil editing', 'multiple folders' and the actual version number. Can anyone think of a symbol that conveys 'look out for different info elsewhere'?

Date: Thursday, November 15th, 2007 11:45 am (UTC)
From: [identity profile] easterbunny.livejournal.com
Change in font colours?

Date: Thursday, November 15th, 2007 11:49 am (UTC)
From: [identity profile] tamaranth.livejournal.com
Good thought: would be fine onscreen but not so good in the dead-tree version ...

Date: Thursday, November 15th, 2007 12:00 pm (UTC)
From: [identity profile] the-magician.livejournal.com
Must admit I tend to use something like

[v9.2 only]

[pre v9.0]

[changed 1st Jan 2007]

Date: Thursday, November 15th, 2007 12:28 pm (UTC)
From: [identity profile] tamaranth.livejournal.com
I need a symbol to tag paras, a single entity that I can include or exclude on the basis of the 'audience' attribute in DITA. Specific text-based information may or may not be included depending on other factors (role, publication medium).

Date: Thursday, November 15th, 2007 03:03 pm (UTC)
From: [identity profile] the-magician.livejournal.com
We have icons for v9.2, v9.3 etc. that we can tag sections with ... but I think we're using DITA to pull in tagged paragraphs that are release specific so that the entity you're looking for we just wouldn't show.

Sorry I can't be of help :-(

Date: Thursday, November 15th, 2007 03:11 pm (UTC)
From: [identity profile] tamaranth.livejournal.com
The issue isn't so much the release-specific stuff as that the audience need to be aware that some areas are dramatically different and old techniques won't work. (Context: starting with the current version and going forward, we're implementing certification for new support staff, who will also be supporting older versions. Some of the functionality remains unchanged: other bits are dramatically different. And the same document will be published externally -- for an audience who don't need to know about previous versions -- and for internal support staff who Know All This and just need a reference manual.)

Date: Thursday, November 15th, 2007 02:23 pm (UTC)
From: [identity profile] hairyears.livejournal.com
Pick up 'Windows XP for Dummies' or any similar book in the series. They make effective use of paragraph icons and probably have what you need, as they were forced to address changes from the previous vesions of Windows.

Date: Thursday, November 15th, 2007 03:12 pm (UTC)
From: [identity profile] tamaranth.livejournal.com
windoze? does not have. (Not quite true, but we are a Linux house and Windows documentation is thin on the ground.) I think I probably did pick up this idea of paragraph-icon design from the Dummies books, though, so thanks for pointing me at them!

Date: Saturday, November 17th, 2007 11:28 pm (UTC)
From: [identity profile] avirr.livejournal.com
I'd probably go with an indented paragraph, maybe in a box, with a little text reminder heading about the exact old version number. The more you set it off like that, the easier for the non-target audience to skim down and ignore it.

I think I once had a dream about you and tech writing!

July 2025

S M T W T F S
   1 234 5
6 789101112
13141516171819
20212223242526
2728293031  

Most Popular Tags

Expand Cut Tags

No cut tags