Need suggestions for proofreading online help files

I have created online help docs off an on for many years...
and have contemplated this issue several times and never come up
with a really good answer.
Right now, the product manager is tryiing to proof one of the
online help files that i've COMPLETELY revamped and he's
complaining about the time this is taking and how difficult it is
because not all topics are in the TOC...
so I suppose i could regnerate the TOC and include EVERY
SINGLE topic... but I was wondering if anyone else had any other
suggestions for best practices when it comes to reviewing online
help files.
THANKS for any input you might have.

Umm!. I have to admit that I find your approach of adding ALL
topics to the TOC works as well as any. However it does cause
problems where one or more popup topics appear in the same topic.
This causes a bit of uncertainty unless there is a clear indication
in the topic where a popup exists and an understanding of what TOC
topic to look at. What I tend to do is have a piece of text (e.g.
see popup titled xxxxx) which has a conditional build tag on it.
Then you include the build tag when you compile. I also tend to
have all the popups in a separate book in the TOC. You can then
easily remove all the popups from the finalised output. It means a
bit of tossing and turning between TOC chapters but seems to work
reasonably well. You could also produce two printed copies, one
containing the popups and another containing the main topic
content. Hope this helps solve your conumdrum.

Similar Messages

  • Need suggestions for good online Adobe classes in photoshop, ill. indesign etc.

    Hi I am a graphic designer and would like some suggestions for good online Adobe classes ... I found
    Adobe Master Series Online Training Library at the Adobe store and was wondering has anyone had good, bad ugly experience with this before I make the purchase. The suite offers training in Photoshop, Illustrator, InDesign, Dreamweaver, Flash, and various Macromedia titles so it covers it all for me in one go.

    A less expensive, non-subscription option would be http://www.vtc.com they offer many video cds for applications that have given many I know a leg up on learning an application.

  • I need suggestions for an online trading application

    Hi,
    I am going to develop an online trading application. I have decided to use JAVA EE 5 and I have read "The Java(tm) EE 5 Tutorial". Because I am a (C++) programmer and new to Java, I need suggestions to start development.
    Here is summary of the system in my mind. There will be
    a database to store user's information and operations,
    a web client for creating and managing user accounts,
    a desktop application and web client for users for online trading and
    an application client for brokers for risk management.
    Here is a sample scenario for flow,
    - User wants to create an account
    - Company creates an account for user
    - user gets the prices and trades via application client (web or desktop)
    - system informs dealers and broker via their client platform
    - broker perform necessary operations.
    Java EE 5 Application model fits the system I am trying to develop but I feel I still need some guidance and there are a few things I couldn't figured out yet. For these reasons I want to develop a prove of concept system and this is the system in my mind.
    - A simple database
    user (user_id, user_login, user_password, user_name)
    stock (stok_id, stok_name)
    operation (op_id, user_id, stok_id, op_type, op_amount, op_value)
    - A price server
    will generate random prices and push new values to registered clients
    - A web client to create new users (for admin)
    - A web client to display operations of users (for user)
    - A desktop application and web client for operation entries (for users)
    displays prices coming from price servers, sends users trade requests
    - A desktop application client for informing admin about trades (for admin)
    when a user buys or sells something, this client notified (user buy/sell something)
    What do you offer for this sample system?
    Which is the best IDE?
    Which Application Server should I use (scalability and speed is critical)?
    Which Java EE APIs should I use?
    JSP or JSF?
    Will I need hibernate?
    And so on.. I need some points to start and go.
    Thanks for any help.
    Ahmet

    It wouldn't be an arbitrary track. However, maybe you could make an arbitrary track by dividing the track into segments. Each segment is either a straight line or an arc. These are easy to model the cars' behavior on, because you'll have a straightforward way to determine the direction the car should be facing, and the range to the left and right where the car can stray and still be on the track.

  • Need Suggestion for Archival of a Table Data

    Hi guys,
    I want to archive one of my large table. the structure of table is as below.
    Daily there will be around 40000 rows inserted into the table.
    Need suggestion for the same. will the partitioning help and on what basis?
    CREATE TABLE IM_JMS_MESSAGES_CLOB_IN
    LOAN_NUMBER VARCHAR2(10 BYTE),
    LOAN_XML CLOB,
    LOAN_UPDATE_DT TIMESTAMP(6),
    JMS_TIMESTAMP TIMESTAMP(6),
    INSERT_DT TIMESTAMP(6)
    TABLESPACE DATA
    PCTUSED 0
    PCTFREE 10
    INITRANS 1
    MAXTRANS 255
    STORAGE (
    INITIAL 1M
    NEXT 1M
    MINEXTENTS 1
    MAXEXTENTS 2147483645
    PCTINCREASE 0
    BUFFER_POOL DEFAULT
    LOGGING
    LOB (LOAN_XML) STORE AS
    ( TABLESPACE DATA
    ENABLE STORAGE IN ROW
    CHUNK 8192
    PCTVERSION 10
    NOCACHE
    STORAGE (
    INITIAL 1M
    NEXT 1M
    MINEXTENTS 1
    MAXEXTENTS 2147483645
    PCTINCREASE 0
    BUFFER_POOL DEFAULT
    NOCACHE
    NOPARALLEL;
    do the needful.
    regards,
    Sandeep

    There will not be any updates /deletes on the table.
    I have created a partitioned table with same struture and i am inserting the records from my original table to this partitioned table where i will maintain data for 6 months.
    After loading the data from original table to archived table i will truncating the original table.
    If my original table is partitioned then what about the restoring of the data??? how will restore the data of last month???

  • Need suggestion for designing a BEx report

    Hi,
    I need suggestions for designing a BEx report.
    Iu2019ve a DSO with below structure:
    1. Functional Location u2013 Key
    2. Maintenance Plan u2013 Key
    3. Maintenance Item u2013 Key
    4. Call # - Key
    5. Cycle u2013 Data Field
    6. Planned Date u2013 Data Field
    7. Completion Date u2013 Data Field
    This DSO contains data like:
    Functional -
    Plan --- Item -
    Call# --- Cycle -
    Planned Dt -
    Completion Dt
    Location
    11177 -
         134 -
         20 -
         1 -
    T1 -
         02-Jan-2011 -
         10-Jan-2011
    11177 -
         134 -
         20 -
         2 -
    T2 -
         15-Feb-2011 -
    11177 -
         134 -
         20 -
         3 -
    T1 -
         15-Mar-2011 -
    11177 -
         134 -
         20 -
         4 -
    M1 -
         30-Mar-2011 -
    25000 -
         170 -
         145 -
         1 -
    T1 -
         19-Jan-2011 -
         19-Jan-2011
    25000 -
         134 -
         145 -
         2 -
    T2 -
         20-Feb-2011 -
         25-Feb-2011
    25000 -
         134 -
         145 -
         3 -
    T1 -
         14-Mar-2011 -
    Now Iu2019ve to create a report which will be executed at the end of every month and should display the list of Functional Locations whose Cycles were planned in that particular month, along with the last completed Cycle/Date.
    Thus based upon above data, if I execute report at the end of (say) March then report must display:
    Functional ---     Curr. Cycle --- Planned Date --- Prev. completed Cycle --- Prev Completed Date
    Location
    11177 -
         T1 -
         15-Mar-2011 -
    ---     T1 -
    --     10-Jan-2011
    11177 -
         M1 -
         30-Mar-2011 -
    ---     T1 -
    --     10-Jan-2011
    25000 -
         T1 -
         14-Mar-2011 -
    ---     T2 -
    --     25-Feb-2011
    Any idea how can I display Previous Completed Cycle and Completion Date (i.e. the last two columns)?
    Regards,
    Vikrant.

    hi vikrant,
    You can a Cube at the reporting layer  which gets data from DSO and which has these 2 extra characteristics completion date and previous cycle along with other chars and keyfigures from DSO.
    You can populate these  based on your logic in the field routine.
    Hope it helps.
    Regards
    Dev

  • I need format for data in excel file load into info cube to planning area.

    Hi gurus,
    I need format for data in excel file load into info cube to planning area.
    can you send me what should i maintain header
    i have knowledge on like
    plant,location,customer,product,history qty,calander
    100,delhi,suresh,nokia,250,2011211
    if it is  right or wrong can u explain  and send me about excel file format.
    babu

    Hi Babu,
    The file format should be same as you want to upload. The sequence of File format should be same communication structure.
    Like,
    Initial columns with Characteristics (ex: plant,location,customer,product)
    date column (check for data format) (ex: calander)
    Last columsn with Key figures (history qty)
    Hope this helps.
    Regards,
    Nawanit

  • Finding difficulty in using Acrobat Editor, need some tutorials or online help in editing pdf's

    finding difficulty in using Acrobat Editor, need some tutorials or online help in editing pdf's

    Press F1 within the application to open the Help section.
    If you have specific questions ask them in the Acrobat forums (this is the Reader forum).

  • Online Help files not working on LR 6

    I am new to this forum and hope this question is posted correctly. I just downloaded a standalone version of LR6 but when I try to reach the online help files I am met with a message saying that Safari cannot reach the page. Can anyone please ?

    I am new to this forum and hope this question is posted correctly. I just downloaded a standalone version of LR6 but when I try to reach the online help files I am met with a message saying that Safari cannot reach the page. Can anyone please ?

  • How do I get a more modern look and feel for a compiled help file

    I gather from reading various posts that there is no easy way
    to generate a .chm file with a more modern look and feel (am I
    right about this?). Are there no plug-ins available from Adobe that
    will enable us to generate a help file that looks more modern?
    I hesitate to move to flash help or something like that
    because, of course, then the developers would have to hookup the
    hundreds of dialog boxes we have in our product to the new files. I
    also think that having one file is way easier to manage in terms of
    getting updated help to the customers. What are online Help
    developers generally delivering for apps where users are not
    connected to the Internet except perhaps periodically while using
    the software? I'm a writer (not a developer) so need soemthing that
    is easy to implement :-)
    Thanks for your help. It is much appreciated.

    To add to the advice already offered, you can apply a skin to
    a CHM file which allows you to customise it. However as with most
    things there are issues with this approach. You can read about this
    by downloading Rick Stone's excellent
    tips
    'n tricks file. Just look in the index under "skins". Something
    else you may want to look at is the beta of Adobe's
    AIR.

  • FM12-XML online help files

    How do I find original source files for an XML-generated online help system created in FM12? What are POM files?
    I must take over from previous tech writer to fix the files and regenerate them and I haven't a clue how to do it in FM 12.
    I've created online help in the past, using RoboHELP without any coding.
    HELP PLEASE. I am under the gun and struggling.
    Thanks.

    A quick search on the 'Net suggests that .pom may be
    File used by Maven, a Java program used to build Java applications and manage their dependencies; contains build information, such as required software dependencies, dependency scope, and packaging information. […] NOTE: POM files are more commonly seen with an .XML file extension. They most commonly use the filename pom.xml.
    Another post says
    Maven POM files are not eBooks. They are configuration files for the Maven software dependency management system for building Java software. […] If the files you have downloaded are indeed Maven POM files, then they are a type of XML text file. You should be able to open them in a web browser or a text editor like Wordpad.
    As for how to start from FM and get to .pom files, I'm afraid I have absolutely no idea. I'll watch this thread with interest … and sympathy :-}

  • Suggestions for improving JDeveloper help

    My impressions of JDeveloper so far (2 weeks) are good, but I have some whinges about the Help system (as one of my project managers once said: "What's a software developer's favourite drink?" - "Whine").
    In no particular order:
    1) When you're going through a tutorial or procedure description in JDeveloper Help then you bring up a dialog, say a wizard, on Windows NT it's impossible to get back to the help to continue reading about the procedure until you exit the dialog. On Windows 2000 it can be done using Alt-Esc, but the normal Alt-Tab doesn't get you there.
    2) On a similar tack, if you have the Help window displayed in JDeveloper then invoke a dialog, then invoke Help from the dialog, you can see the Help window but can't actually select it so as to resize or scroll it, for example.
    3) Some of the tutorials and procedure descriptions haven't been tested thoroughly from scratch and are missing steps or sub-procedures. Sorry I can't be more specific but I've just noticed it going through and didn't think to note it down at the time. I have only looked at creating and testing BC4J, EJB and Web Service projects so far, and specifically created a Web Service that fronted a session EJB that used a BC4J application module in local mode to access the database. It took me a few goes and some guessing to get it working.
    4) BC4J needs a more comprehensive introduction that really gives a proper overview of how you plan, design and implement a BC4J project. The Help facility is probably not the best place for that as it's something that one needs to be able to read at leisure in a more book-like format - perhaps a PDF file (there may already be one dedicated to BC4J but I haven't stumbled across it yet).
    Regards,
    Yaqoob Johnson

    Hi Yaqoob
    Thanks for your comments. We're working on improving some of the shortcomings you mention in your post.
    Your first two points are being addressed by the development team responsible for Oracle Help for Java (OHJ). The modality problem is related to one of the top 25 Java RFEs in the Javasoft bug database. We're waiting for the fix.
    The tutorials are being improved and revised for the next JDev release. Please let us know what you think.
    We are revamping our BC4J doc over the next few releases. In the 903 release of JDev, you'll notice that there is more BC4J overview and introductory material. In addition, the BC4J doc is being reorganized.
    Glad you like the PDF version of the online help.
    Cathy

  • Suggestions for how to execute file maintenance in SQL Agent Job

    I need to create a SQL Agent Job (it has to be a SQL agent job) to zip all files in a directory, delete all files in the directory but the zip file and then copy the zip file to another location across a UNC path. What are some suggestions for getting
    this done? 
    Thanks.

    This is about a previous topic ...
    "1. Please close your preview thread by marking the answers that you got and not your own summary. Actualy you can mark your summary as well if you feel that this close the thread but yet, this is a summary of the answers that you got! People
    that help you Invested time to help you. Feel free to
    not be lazy and start you can start voting helpful responses as well :-)"
    How do you mark useful answers? I have not seen how to do that.
    On the left of each response you have an icon (small image).
    I have asked lots of questions on the TechNet and other forums. (One day I hope to even answer some.) That was the first time I had ever marked my own as the answer. Honestly, I did not use any of those well meaning replies and did not feel that any of them
    answered my question. When researching a topic I, like most people, I look at the marked answer first and assume it is the answer. Did not feel that  any of them were the answer. There is a great push on this forum to mark the answer and there are droves
    of people clamoring for points (BTW - you are not one of them). I review each of my questions, always follow up on any  replies, post my solution if appropriate, and always try to close the topic. But this one was not answered.
    OK, that is logic, If you dont think that you use other response as part of the answer. In my opinion (and you dont have to get it) if an answer is build from 3 responses together then we need to mark all the three (and mentioned in the summery what we have
    done). If you find that those response cant be called "answer" since they do not cover enough then maybe your call was correct.
    Please close the thread in the way that you feel is OK :-)
    (you dont have to accept my opinion since you have your explanation, but i do think that some of the responses there are answers).
    [Personal Site] [Blog] [Facebook]

  • Need suggestion for USB Bluetooth Adapter for HP Z230 Workstation

    I've just purchased an HP Z230 Workstation, with an I7 processor.  I need to equip it with Bluetooth capability so that I can connect the computer to an old Palm Tungsten T2. 
    There are gobs of USB 4.0 Bluetooth adapters / dongles on the market, but reading buyer's comments, they all seem to have some type of problem with compatibility or installation issues on something.
    Does anyone have a suggestion for a USB Bluetooth adapter that has worked well with the Z230?
    Thanks in advance for any help.
    Terry
    This question was solved.
    View Solution.

    I suggest joining the Enterprise Buisness forum and posting your query there.
    Your  HP Z230 Workstation is a business class HP product and not than a consumer class device. This is the HP Consumer support forum.
    ****Please click on Accept As Solution if a suggestion solves your problem. It helps others facing the same problem to find a solution easily****
    2015 Microsoft MVP - Windows Experience Consumer

  • Need suggestion for new laptop

    Hi, everyone I'm needing suggestions. I had a touchsmart tx2z however after nearly 4 years it has bit the dust couldn't be saved after its last crash computer would turn on but screen would stay black and ome of the keys like the caps lock would flash. Computer guys say my motherboard has gone bad.  I'm looking for another computer now but would like one that is similar to the hp touchsmart but does not cost a lot of money.  

    Here is the current line-up of HP Touchscreen Laptops. Prices start at about $650 and go up from there. $650 sounds OK to my for a touchscreen laptop, but price is a subjective item. If these are too rich for you, you could always look at regular laptops.
    Please send KUDOs
    Frank
    {------------ Please click the "White Kudos" Thumbs Up to say THANKS for helping.
    Please click the "Accept As Solution" on my post, if my assistance has solved your issue. ------------V
    This is a user supported forum. I am a volunteer and I don't work for HP.
    HP 15t-j100 (on loan from HP)
    HP 13 Split x2 (on loan from HP)
    HP Slate8 Pro (on loan from HP)
    HP a1632x - Windows 7, 4GB RAM, AMD Radeon HD 6450
    HP p6130y - Windows 7, 8GB RAM, AMD Radeon HD 6450
    HP p6320y - Windows 7, 8GB RAM, NVIDIA GT 240
    HP p7-1026 - Windows 7, 6GB RAM, AMD Radeon HD 6450
    HP p6787c - Windows 7, 8GB RAM, NVIDIA GT 240

  • Need suggestion for choosing Java development enviroment

    Hi Evereyone,
    I am new to Java Desktop Application.I need help on choosing proper Java technologies and development tool.
    We have an existing CLIENT/SERVER based distributed control system, which was developed in C++(Server side) and VB(Client GUI).Now we are think of migrating the system to Java platform.
    Here is the outline:
    We want to create web based application that will run on windows and linux (linux on embedded PC).
    The application should be able to support 10 � 100 users at once accessing/editing database.
    We will also need to create a communication server that will run on web server P.C. that will communicate tcpip to field panels/log to db, as well as allow web screens to send/receive commands with field panels etc.
    Could any one give me some suggestion about it?
    I am thinking of Using J2SE 5.0, including RMI, JDBC and Swing for GUI. As for field panels, may choose J2ME.
    Thank you very much in advance.

    Thanks, zadok .
    Actually, I don't have the system requirements neither. All I know is the following outline:
    "We want to create web based application that will run on windows and linux (linux on embedded PC).
    The application should be able to support 10 � 100 users at once accessing/editing database.
    We will also need to create a communication server that will run on web server P.C. that will communicate tcpip to field panels/log to db, as well as allow web screens to send/receive commands with field panels etc."
    It is a interview question, which need me to do research and give some suggestions. What I want to know is to figure out what kind of Java technology is necessary for developing this system because I want to make sure I head to right direction.
    I know somehow it is hard to give suggestion based on this limited information.
    One more thing I was confusing is the server-side architecture.
    I need suggestion about sever side architecture:
    a. write a dedicated server-side program, which act
    as communication server to monitor and control field
    panel, also act as server-side applicaiton by using
    RMI to communicate with Client-side communication.
    b. choose a general web server architecture. Put
    everything in server side in Web Server, for example
    Tomcat AS container, implementing the Communication
    server as Web Service and the request from
    Client-side go to Web Server first, then dispatch to
    a proper web service.Why did you not include this information in the original question!
    Why don't you just use Tomcat?
    For your answer, "Why don't you just use Tomcat?", does it mean Tomcat without Web Service will be enough for this system development? Could you give me some detail about it?
    Thank you very much, zadok.

Maybe you are looking for