Document (#25225)

Author

Holbert, S.

Title

How to index Windows-based online help

Issue

Beyond book indexing: how to get started in Web indexing, embedded indexing and other computer-based media. Ed. by D. Brenner u. M. Rowland.

Imprint

Phoenix, AZ : American Society of Indexers / Information Today

Year

2000

Pages

S.89-97

Abstract

Today, more and more software packages come with online documentation. Some have complete manuals as well. Others have basic documentation on paper and more advanced information online. I recently purchased a computer that came with 20 software programs and not one page of written documentation. More and more, users have to find information by searching online. Most documentation teams focus on writing and ignore the problems of information retrieval, making information in printed documents difficult to find, and online information impossible to find. With online Help, you cannot browse the documentation. You cannot even browse more than a couple of inches of the index at a time. If online users do not get superb guidance into the jungle of online Help, they go away like the hero of Joseph Conrad's Heart of Darkness, saying "Oh, the horror! The horror!" How does an online Help index work? The following examples are based on the Windows 95 Help-type system, but do not represent actual Help screens

Theme

Register

Similar documents (content)

1. Laan, H.v.d.: Endnote Plus voor de eindgebruiker (1997) 0.27

   0.26778266 = sum of:
     0.26778266 = product of:
       0.83682084 = sum of:
         0.02200299 = weight(abstract_txt:users in 1360) [ClassicSimilarity], result of:
           0.02200299 = score(doc=1360,freq=1.0), product of:
             0.06579177 = queryWeight, product of:
               3.5672934 = idf(docFreq=3408, maxDocs=44421)
               0.01844305 = queryNorm
             0.33443376 = fieldWeight in 1360, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               3.5672934 = idf(docFreq=3408, maxDocs=44421)
               0.09375 = fieldNorm(doc=1360)
         0.011307411 = weight(abstract_txt:with in 1360) [ClassicSimilarity], result of:
           0.011307411 = score(doc=1360,freq=1.0), product of:
             0.048319563 = queryWeight, product of:
               1.049594 = boost
               2.4961398 = idf(docFreq=9949, maxDocs=44421)
               0.01844305 = queryNorm
             0.23401311 = fieldWeight in 1360, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               2.4961398 = idf(docFreq=9949, maxDocs=44421)
               0.09375 = fieldNorm(doc=1360)
         0.11634957 = weight(abstract_txt:screens in 1360) [ClassicSimilarity], result of:
           0.11634957 = score(doc=1360,freq=1.0), product of:
             0.15849552 = queryWeight, product of:
               1.0975081 = boost
               7.8302665 = idf(docFreq=47, maxDocs=44421)
               0.01844305 = queryNorm
             0.73408747 = fieldWeight in 1360, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               7.8302665 = idf(docFreq=47, maxDocs=44421)
               0.09375 = fieldNorm(doc=1360)
         0.1238043 = weight(abstract_txt:windows in 1360) [ClassicSimilarity], result of:
           0.1238043 = score(doc=1360,freq=1.0), product of:
             0.208133 = queryWeight, product of:
               1.7786262 = boost
               6.3448815 = idf(docFreq=211, maxDocs=44421)
               0.01844305 = queryNorm
             0.59483266 = fieldWeight in 1360, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               6.3448815 = idf(docFreq=211, maxDocs=44421)
               0.09375 = fieldNorm(doc=1360)
         0.056961052 = weight(abstract_txt:more in 1360) [ClassicSimilarity], result of:
           0.056961052 = score(doc=1360,freq=1.0), product of:
             0.17889968 = queryWeight, product of:
               2.8561409 = boost
               3.3962307 = idf(docFreq=4044, maxDocs=44421)
               0.01844305 = queryNorm
             0.31839663 = fieldWeight in 1360, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               3.3962307 = idf(docFreq=4044, maxDocs=44421)
               0.09375 = fieldNorm(doc=1360)
         0.16210848 = weight(abstract_txt:help in 1360) [ClassicSimilarity], result of:
           0.16210848 = score(doc=1360,freq=1.0), product of:
             0.35927585 = queryWeight, product of:
               4.0475187 = boost
               4.8128953 = idf(docFreq=980, maxDocs=44421)
               0.01844305 = queryNorm
             0.45120895 = fieldWeight in 1360, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               4.8128953 = idf(docFreq=980, maxDocs=44421)
               0.09375 = fieldNorm(doc=1360)
         0.23695062 = weight(abstract_txt:documentation in 1360) [ClassicSimilarity], result of:
           0.23695062 = score(doc=1360,freq=1.0), product of:
             0.4354474 = queryWeight, product of:
               4.0677295 = boost
               5.8043137 = idf(docFreq=363, maxDocs=44421)
               0.01844305 = queryNorm
             0.5441544 = fieldWeight in 1360, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               5.8043137 = idf(docFreq=363, maxDocs=44421)
               0.09375 = fieldNorm(doc=1360)
         0.10733641 = weight(abstract_txt:online in 1360) [ClassicSimilarity], result of:
           0.10733641 = score(doc=1360,freq=1.0), product of:
             0.31242996 = queryWeight, product of:
               4.6227117 = boost
               3.6645708 = idf(docFreq=3092, maxDocs=44421)
               0.01844305 = queryNorm
             0.3435535 = fieldWeight in 1360, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               3.6645708 = idf(docFreq=3092, maxDocs=44421)
               0.09375 = fieldNorm(doc=1360)
       0.32 = coord(8/25)
   

2. Gilmore, F.L.: Compton's Multimedia Encyclopedia (1992) 0.20

   0.19687943 = sum of:
     0.19687943 = product of:
       0.820331 = sum of:
         0.13574117 = weight(abstract_txt:screens in 6188) [ClassicSimilarity], result of:
           0.13574117 = score(doc=6188,freq=1.0), product of:
             0.15849552 = queryWeight, product of:
               1.0975081 = boost
               7.8302665 = idf(docFreq=47, maxDocs=44421)
               0.01844305 = queryNorm
             0.8564354 = fieldWeight in 6188, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               7.8302665 = idf(docFreq=47, maxDocs=44421)
               0.109375 = fieldNorm(doc=6188)
         0.04680433 = weight(abstract_txt:software in 6188) [ClassicSimilarity], result of:
           0.04680433 = score(doc=6188,freq=1.0), product of:
             0.09819212 = queryWeight, product of:
               1.2216661 = boost
               4.3580413 = idf(docFreq=1545, maxDocs=44421)
               0.01844305 = queryNorm
             0.47666076 = fieldWeight in 6188, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               4.3580413 = idf(docFreq=1545, maxDocs=44421)
               0.109375 = fieldNorm(doc=6188)
         0.027778191 = weight(abstract_txt:have in 6188) [ClassicSimilarity], result of:
           0.027778191 = score(doc=6188,freq=1.0), product of:
             0.07938144 = queryWeight, product of:
               1.3453006 = boost
               3.199388 = idf(docFreq=4924, maxDocs=44421)
               0.01844305 = queryNorm
             0.34993306 = fieldWeight in 6188, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               3.199388 = idf(docFreq=4924, maxDocs=44421)
               0.109375 = fieldNorm(doc=6188)
         0.14443834 = weight(abstract_txt:windows in 6188) [ClassicSimilarity], result of:
           0.14443834 = score(doc=6188,freq=1.0), product of:
             0.208133 = queryWeight, product of:
               1.7786262 = boost
               6.3448815 = idf(docFreq=211, maxDocs=44421)
               0.01844305 = queryNorm
             0.6939714 = fieldWeight in 6188, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               6.3448815 = idf(docFreq=211, maxDocs=44421)
               0.109375 = fieldNorm(doc=6188)
         0.18912654 = weight(abstract_txt:help in 6188) [ClassicSimilarity], result of:
           0.18912654 = score(doc=6188,freq=1.0), product of:
             0.35927585 = queryWeight, product of:
               4.0475187 = boost
               4.8128953 = idf(docFreq=980, maxDocs=44421)
               0.01844305 = queryNorm
             0.5264104 = fieldWeight in 6188, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               4.8128953 = idf(docFreq=980, maxDocs=44421)
               0.109375 = fieldNorm(doc=6188)
         0.27644238 = weight(abstract_txt:documentation in 6188) [ClassicSimilarity], result of:
           0.27644238 = score(doc=6188,freq=1.0), product of:
             0.4354474 = queryWeight, product of:
               4.0677295 = boost
               5.8043137 = idf(docFreq=363, maxDocs=44421)
               0.01844305 = queryNorm
             0.6348468 = fieldWeight in 6188, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               5.8043137 = idf(docFreq=363, maxDocs=44421)
               0.109375 = fieldNorm(doc=6188)
       0.24 = coord(6/25)
   

3. Theriault, L.F.; Jean, J.: Confused? A kid's guide to the Internet's World Wide Web (1995) 0.19

   0.18731917 = sum of:
     0.18731917 = product of:
       0.7804966 = sum of:
         0.06686333 = weight(abstract_txt:software in 2208) [ClassicSimilarity], result of:
           0.06686333 = score(doc=2208,freq=1.0), product of:
             0.09819212 = queryWeight, product of:
               1.2216661 = boost
               4.3580413 = idf(docFreq=1545, maxDocs=44421)
               0.01844305 = queryNorm
             0.68094397 = fieldWeight in 2208, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               4.3580413 = idf(docFreq=1545, maxDocs=44421)
               0.15625 = fieldNorm(doc=2208)
         0.028582973 = weight(abstract_txt:information in 2208) [ClassicSimilarity], result of:
           0.028582973 = score(doc=2208,freq=1.0), product of:
             0.075625725 = queryWeight, product of:
               1.6951925 = boost
               2.4188995 = idf(docFreq=10748, maxDocs=44421)
               0.01844305 = queryNorm
             0.37795305 = fieldWeight in 2208, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               2.4188995 = idf(docFreq=10748, maxDocs=44421)
               0.15625 = fieldNorm(doc=2208)
         0.14104041 = weight(abstract_txt:find in 2208) [ClassicSimilarity], result of:
           0.14104041 = score(doc=2208,freq=1.0), product of:
             0.18487468 = queryWeight, product of:
               2.0530455 = boost
               4.8825436 = idf(docFreq=914, maxDocs=44421)
               0.01844305 = queryNorm
             0.76289743 = fieldWeight in 2208, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               4.8825436 = idf(docFreq=914, maxDocs=44421)
               0.15625 = fieldNorm(doc=2208)
         0.09493509 = weight(abstract_txt:more in 2208) [ClassicSimilarity], result of:
           0.09493509 = score(doc=2208,freq=1.0), product of:
             0.17889968 = queryWeight, product of:
               2.8561409 = boost
               3.3962307 = idf(docFreq=4044, maxDocs=44421)
               0.01844305 = queryNorm
             0.53066105 = fieldWeight in 2208, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               3.3962307 = idf(docFreq=4044, maxDocs=44421)
               0.15625 = fieldNorm(doc=2208)
         0.2701808 = weight(abstract_txt:help in 2208) [ClassicSimilarity], result of:
           0.2701808 = score(doc=2208,freq=1.0), product of:
             0.35927585 = queryWeight, product of:
               4.0475187 = boost
               4.8128953 = idf(docFreq=980, maxDocs=44421)
               0.01844305 = queryNorm
             0.7520149 = fieldWeight in 2208, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               4.8128953 = idf(docFreq=980, maxDocs=44421)
               0.15625 = fieldNorm(doc=2208)
         0.17889401 = weight(abstract_txt:online in 2208) [ClassicSimilarity], result of:
           0.17889401 = score(doc=2208,freq=1.0), product of:
             0.31242996 = queryWeight, product of:
               4.6227117 = boost
               3.6645708 = idf(docFreq=3092, maxDocs=44421)
               0.01844305 = queryNorm
             0.57258916 = fieldWeight in 2208, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               3.6645708 = idf(docFreq=3092, maxDocs=44421)
               0.15625 = fieldNorm(doc=2208)
       0.24 = coord(6/25)
   

4. Hedden, H.: Creating an index for your Web site to make info easier to see (2006) 0.18

   0.18327652 = sum of:
     0.18327652 = product of:
       0.5727391 = sum of:
         0.025670154 = weight(abstract_txt:users in 3189) [ClassicSimilarity], result of:
           0.025670154 = score(doc=3189,freq=1.0), product of:
             0.06579177 = queryWeight, product of:
               3.5672934 = idf(docFreq=3408, maxDocs=44421)
               0.01844305 = queryNorm
             0.39017272 = fieldWeight in 3189, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               3.5672934 = idf(docFreq=3408, maxDocs=44421)
               0.109375 = fieldNorm(doc=3189)
         0.013191979 = weight(abstract_txt:with in 3189) [ClassicSimilarity], result of:
           0.013191979 = score(doc=3189,freq=1.0), product of:
             0.048319563 = queryWeight, product of:
               1.049594 = boost
               2.4961398 = idf(docFreq=9949, maxDocs=44421)
               0.01844305 = queryNorm
             0.2730153 = fieldWeight in 3189, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               2.4961398 = idf(docFreq=9949, maxDocs=44421)
               0.109375 = fieldNorm(doc=3189)
         0.027778191 = weight(abstract_txt:have in 3189) [ClassicSimilarity], result of:
           0.027778191 = score(doc=3189,freq=1.0), product of:
             0.07938144 = queryWeight, product of:
               1.3453006 = boost
               3.199388 = idf(docFreq=4924, maxDocs=44421)
               0.01844305 = queryNorm
             0.34993306 = fieldWeight in 3189, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               3.199388 = idf(docFreq=4924, maxDocs=44421)
               0.109375 = fieldNorm(doc=3189)
         0.020008082 = weight(abstract_txt:information in 3189) [ClassicSimilarity], result of:
           0.020008082 = score(doc=3189,freq=1.0), product of:
             0.075625725 = queryWeight, product of:
               1.6951925 = boost
               2.4188995 = idf(docFreq=10748, maxDocs=44421)
               0.01844305 = queryNorm
             0.26456714 = fieldWeight in 3189, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               2.4188995 = idf(docFreq=10748, maxDocs=44421)
               0.109375 = fieldNorm(doc=3189)
         0.090886734 = weight(abstract_txt:index in 3189) [ClassicSimilarity], result of:
           0.090886734 = score(doc=3189,freq=1.0), product of:
             0.1749511 = queryWeight, product of:
               1.9971845 = boost
               4.7496953 = idf(docFreq=1044, maxDocs=44421)
               0.01844305 = queryNorm
             0.51949793 = fieldWeight in 3189, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               4.7496953 = idf(docFreq=1044, maxDocs=44421)
               0.109375 = fieldNorm(doc=3189)
         0.13962288 = weight(abstract_txt:find in 3189) [ClassicSimilarity], result of:
           0.13962288 = score(doc=3189,freq=2.0), product of:
             0.18487468 = queryWeight, product of:
               2.0530455 = boost
               4.8825436 = idf(docFreq=914, maxDocs=44421)
               0.01844305 = queryNorm
             0.7552299 = fieldWeight in 3189, product of:
               1.4142135 = tf(freq=2.0), with freq of:
                 2.0 = termFreq=2.0
               4.8825436 = idf(docFreq=914, maxDocs=44421)
               0.109375 = fieldNorm(doc=3189)
         0.06645456 = weight(abstract_txt:more in 3189) [ClassicSimilarity], result of:
           0.06645456 = score(doc=3189,freq=1.0), product of:
             0.17889968 = queryWeight, product of:
               2.8561409 = boost
               3.3962307 = idf(docFreq=4044, maxDocs=44421)
               0.01844305 = queryNorm
             0.37146273 = fieldWeight in 3189, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               3.3962307 = idf(docFreq=4044, maxDocs=44421)
               0.109375 = fieldNorm(doc=3189)
         0.18912654 = weight(abstract_txt:help in 3189) [ClassicSimilarity], result of:
           0.18912654 = score(doc=3189,freq=1.0), product of:
             0.35927585 = queryWeight, product of:
               4.0475187 = boost
               4.8128953 = idf(docFreq=980, maxDocs=44421)
               0.01844305 = queryNorm
             0.5264104 = fieldWeight in 3189, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               4.8128953 = idf(docFreq=980, maxDocs=44421)
               0.109375 = fieldNorm(doc=3189)
       0.32 = coord(8/25)
   

5. Eito Brun, R.: Retrieval effectiveness in software repositories : from faceted classifications to software visualization techniques (2006) 0.18

   0.17945625 = sum of:
     0.17945625 = product of:
       0.64091516 = sum of:
         0.020744616 = weight(abstract_txt:users in 3515) [ClassicSimilarity], result of:
           0.020744616 = score(doc=3515,freq=2.0), product of:
             0.06579177 = queryWeight, product of:
               3.5672934 = idf(docFreq=3408, maxDocs=44421)
               0.01844305 = queryNorm
             0.31530717 = fieldWeight in 3515, product of:
               1.4142135 = tf(freq=2.0), with freq of:
                 2.0 = termFreq=2.0
               3.5672934 = idf(docFreq=3408, maxDocs=44421)
               0.0625 = fieldNorm(doc=3515)
         0.08573857 = weight(abstract_txt:teams in 3515) [ClassicSimilarity], result of:
           0.08573857 = score(doc=3515,freq=2.0), product of:
             0.1344855 = queryWeight, product of:
               1.0109669 = boost
               7.212831 = idf(docFreq=88, maxDocs=44421)
               0.01844305 = queryNorm
             0.6375302 = fieldWeight in 3515, product of:
               1.4142135 = tf(freq=2.0), with freq of:
                 2.0 = termFreq=2.0
               7.212831 = idf(docFreq=88, maxDocs=44421)
               0.0625 = fieldNorm(doc=3515)
         0.007538274 = weight(abstract_txt:with in 3515) [ClassicSimilarity], result of:
           0.007538274 = score(doc=3515,freq=1.0), product of:
             0.048319563 = queryWeight, product of:
               1.049594 = boost
               2.4961398 = idf(docFreq=9949, maxDocs=44421)
               0.01844305 = queryNorm
             0.15600874 = fieldWeight in 3515, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               2.4961398 = idf(docFreq=9949, maxDocs=44421)
               0.0625 = fieldNorm(doc=3515)
         0.08457617 = weight(abstract_txt:software in 3515) [ClassicSimilarity], result of:
           0.08457617 = score(doc=3515,freq=10.0), product of:
             0.09819212 = queryWeight, product of:
               1.2216661 = boost
               4.3580413 = idf(docFreq=1545, maxDocs=44421)
               0.01844305 = queryNorm
             0.86133355 = fieldWeight in 3515, product of:
               3.1622777 = tf(freq=10.0), with freq of:
                 10.0 = termFreq=10.0
               4.3580413 = idf(docFreq=1545, maxDocs=44421)
               0.0625 = fieldNorm(doc=3515)
         0.015873253 = weight(abstract_txt:have in 3515) [ClassicSimilarity], result of:
           0.015873253 = score(doc=3515,freq=1.0), product of:
             0.07938144 = queryWeight, product of:
               1.3453006 = boost
               3.199388 = idf(docFreq=4924, maxDocs=44421)
               0.01844305 = queryNorm
             0.19996175 = fieldWeight in 3515, product of:
               1.0 = tf(freq=1.0), with freq of:
                 1.0 = termFreq=1.0
               3.199388 = idf(docFreq=4924, maxDocs=44421)
               0.0625 = fieldNorm(doc=3515)
         0.15283734 = weight(abstract_txt:help in 3515) [ClassicSimilarity], result of:
           0.15283734 = score(doc=3515,freq=2.0), product of:
             0.35927585 = queryWeight, product of:
               4.0475187 = boost
               4.8128953 = idf(docFreq=980, maxDocs=44421)
               0.01844305 = queryNorm
             0.42540386 = fieldWeight in 3515, product of:
               1.4142135 = tf(freq=2.0), with freq of:
                 2.0 = termFreq=2.0
               4.8128953 = idf(docFreq=980, maxDocs=44421)
               0.0625 = fieldNorm(doc=3515)
         0.273607 = weight(abstract_txt:documentation in 3515) [ClassicSimilarity], result of:
           0.273607 = score(doc=3515,freq=3.0), product of:
             0.4354474 = queryWeight, product of:
               4.0677295 = boost
               5.8043137 = idf(docFreq=363, maxDocs=44421)
               0.01844305 = queryNorm
             0.62833536 = fieldWeight in 3515, product of:
               1.7320508 = tf(freq=3.0), with freq of:
                 3.0 = termFreq=3.0
               5.8043137 = idf(docFreq=363, maxDocs=44421)
               0.0625 = fieldNorm(doc=3515)
       0.28 = coord(7/25)