wiki:doc/DocumentationList

Tor Documentation List

Sponsor O

  • These are the documents that are considered most important for Sponsor O's target audience(s). They require various amounts of cleanup, and some of them need to be rewritten entirely.
Document Title Topic Cleanup required Assigned to Date Due
About Tor Tor Overview This could use a bit of love, but is still largely accurate mttp
Abuse FAQ Abuse FAQ Should we ask Wendy? Phoul
Documentation Overview Documentation Overview This will need to be updated once the rest of the documentation work is complete Phoul
FAQ FAQ Matt has been updating this, certain things still need reworking mttp
Freedom & Privacy Online (PDF) (p4) How Tor Works & Censorship Long overdue for being updated in both content and design (feedback has been that the size is too big - should be postcard size) Phoul
Legal FAQ Legal FAQ Should we ask Wendy? Phoul
Short user Manual Easy introduction to running the Tor Browser Bundle This is being entirely rewritten by the support team saint, harmony, Sherief
The Benefits of Anonymity Online (PDF) (p3) How Tor Works & What does Anonymity Mean? Long overdue for being updated in both content and design (feedback has been that the size is too big - should be postcard size) Phoul
Law Enforcement & The Tor Project (PDF) (p2) How Tor Works & Law Enforcement Long overdue for being updated in both content and design (feedback has been that the size is too big - should be postcard size) Phoul
Volunteering Volunteering for the Tor Project Possible reworking, the actual content is still good saint
Tor: Join the Network! (HD) Join the Network! YouTube video
How to use the Tor Browser video How to use the Tor Browser video Need to be entirely redone due to Tor Browser changes Sherief

General updating

  • These are documents that have been identified as being out of date, or needing some form of work done on them. These are documents that are not currently considered to be in-scope for the Sponsor O outreach target audience(s). Content from these resources may still be pulled for training curriculum development, or other purposes.
Document Title Topic Cleanup required Assigned to Date Due
Tor on Debian / Ubuntu Deb-based Tor package installation Possible reworking, content is good
Tor packages for RPM-based linux distributions RPM-based Tor package installation Needs updating, certain things are unclear and we do not offer OpenSUSE bundles
Vidalia on Ubuntu or Debian Vidalia on Debian / Ubuntu Either update or drop this
Running a mirror Running a Tor Project mirror Possible reworking, the actual content is still good
Pluggable Transports Pluggable Transport information Content is good, this page doesn't need anything
Configuring a Tor relay Relay configuration Should be updated to have less of a focus on Vidalia configuration
Configuring Hidden Services for Tor Hidden service configuration Possible reworking, content is still good. This will need rewriting once the HS publishing portion of Sponsor O is complete
Our Projects Projects page Will need updating once other portions of SponsorO start wrapping up
Running the Tor client on Microsoft Windows Tor on Windows (Not TBB) Aside from relays, this might be worth dropping
Running Tor on Mac OSX Tor on OSX (Not TBB) Aside from relays, this might be worth dropping
Running the Tor client on Linux/BSD/Unix Tor on Linux/BSD (Not TBB) Aside from relays, this might be worth dropping
Bridges Usage and deployment of bridges This needs to be rewritten; the client documentation still expects Vidalia Sherief, sysrqb
Configuring Tor to use a Proxy Tor proxy configuration This needs to be rewritten; the documentation still expects Vidalia Sherief

Tor Documentation Map

The following "map" tries to organize the documents in the table above to get a better idea what might be missing or redundant. It still needs work.

https://people.torproject.org/~karsten/volatile/tor-documentation-map.svg

Explanation:

  • Breadth: how broad or narrow is the thing we're documenting? The broadest is how Tor fits into the Internet security and privacy landscape, and then it gets more narrow when documenting how to use Tor, how to run Tor network parts or services as a volunteer, and finally to run services if you're The Tor Project.
  • Depth: how much time does somebody have to read a document, and what technical expertise do they have? This goes from a 1-5 minute elevator pitch (depending on building height) over a 5-15 minutes read of a guide, manual, or FAQ, to 30 minutes or more for a reference or design document.
  • Frequency (not shown): how frequently will a document be read? This dimension is not in the map but can be derived from breadth and depth. A document in the upper-left part of the map may be read tens of thousand times per year, whereas a document in the lower-right part maybe ten times per year. This dimension may be important when assigning priorities and resources to create or update documents.
Last modified 3 years ago Last modified on Jan 12, 2015, 11:50:43 PM