Colored Code

Subject: Colored Code
From: "Simon North" <Simon -dot- North -at- quintiq -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 19 Nov 2004 14:23:50 +0100


Oh, the joys of having a micromanager.

The tools I am documenting require me to include software code. Our
editor has color highlighting (red, blue, green), which will be familiar
to many of you. My manager wants me to use the same color highlighting
in the documentation (and online help).

I have tried fending it off on the grounds that it would be labor
intensive to do (not to mention the extra QA work), though I also
consider it ugly and amateur. We use discrete colors in the docs and
online help, with which the bright colors of highlighting are going to
clash violently. In the online help, I think it will be a major
distraction. Generally, I'm afraid the docs are going to look like an
infant was let loose with a pot of paints. My manager wants to press
the point and intends to put it out to a vote.

Please, can you give me a peer vote? Am I being pedantic, or would you
support my stance? Help!!!

Simon North

I won't mention the company name ...

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

ROBOHELP X5 - SEE THE ALL NEW ROBOHELP X5 IN ACTION!

RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo: http://www.macromedia.com/go/techwrldemo

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: RE: PDF to Word or TXT
Next by Author: RE: Colored Code
Previous by Thread: Re: Writing tests for Peoplesoft contract position?
Next by Thread: Re: Colored Code


What this post helpful? Share it with friends and colleagues:


Sponsored Ads