W3C Style Guide

Date: Thu, 1 Feb 96 12:48 CST
To: timbl@w3.org, comp-text-sgml@naggum.no
Newsgroups: comp.infosystems.www.authoring.misc,alt.hypertext,alt.culture.www
Subject: WWW-RANT: Biting the hand that gave us birth-- sorry TBL
Summary: critique of Tim Berners-Lee's style guide
From: jorn@mcs.com (HyperTerrorist)
Organization: The Responsible Party

I've been reluctant to critique Tim Berners-Lee's WWWeb style guide at
<>, because Tim invented
the WWWeb, and for that alone he should bask in glory, all his days...

But, all the same, his guide is seriously flawed, both in the design 
strategies it recommends, and the ones it embodies.  So here's a
brief list of what I see as its errors.

Far too often, Tim fails to take his own advice:

- Site not checked with lynx, navigation buttons lack ALT text thruout
- Multiple audiences mixed-- beginner and technical-- tech terms undefined
<Introduction.html> &c
- Spellcheck needed thruout
- Broken HTML
<Testing.html> "client list"

- Links not carefully tested
  - Back button skips one file
  - Next button skips several files
  - File revised and relocated, but many links not updated!?!
<../../Provider/Etiquette.html> old
<Etiquette.html> new

- Inconsistent navigation buttons (so prevalent it seems intentional?)
  - A rare case of all buttons correctly in place
  - Button missing from all pages but one
<TITLE.html> "markup"
  - [Prior] button at bottom not top of page-- thruout
  - No [Prior] button
  - No [Next] button ('stairmaster fallacy')
  - Orphan page (no up-link)
  - Foster-orphan (uplink skips levels)

- Misleading links
  - Disguised up-links
<Etiquette.html> "This Guide"
<WithinDocument.html>"style guide"
<IntoContext.html> &c "Part of"
  - Unsignalled/confusing violations of tree-structure
<Introduction.html> miniToC at end
<Etiquette.html> "Signing""status"
<DeviceIndependent.html> "testing"
<Testing.html> "make it clear"
  - Unclear whether link is #-link or separate doc
<> all subheads in ToC
  - 'Junk links' to sites used as definitions of terms
<> "WWW"
<../../People/Berners-Lee/>  many examples
  - Anchor text doesn't clearly explain contents of target page
<Etiquette.html> "rule file"
<DocSize.html> "next"
<ReferOrCopy.html> hotlist at end
<ReadableText.html> "I'm" (#-link)
  - Anchor text trimmed excessively (the more self-explanatory the better)
  "WWW" could be "WWW product documentation"
  "single page" could be "single page version of the whole thing"
  "HTML overview" could be "the W3C HTML overview"
  - Live demo-links distracting
<Printable.html> "device ind."

- Wasted pages
  - Sub-ToCs waste reader's time
  - Too-short pages waste readers' time
  - Undescriptive table of contents should *summarize* each 'chapter'
<> [better than average]

The advice Tim offers is often topnotch, but occasionally very doubtful:

'One page per idea' is a bad idea with non-local latencies

'Footnotes a page each' is unworkable for the same reason.  Keep footnotes
on the same page.

'Use <h?> headers in strict order' is too limiting.  Eg, subpages at least
ought to be allowed to start with <h2>.

FTP and other non-HTTP links should be labelled so, in general.

Sharing the same pages between expert and novice views is not usually a
real advantage.


. hypertext theory : artificial intelligence : finnegans wake . _+m"m+_"+_ 
              lynx ¬http://www.mcs.net/~jorn/ !            Jp   Jp     qh qh
          ¬ftp://ftp.mcs.net/mcsnet.users/jorn/            O    O       O  O
                ¬news:alt.music.category-freak             Yb   Yb     dY dY
...do you ever feel your mind has started to erode?        "Y_  "Y5m2Y"  "  no.