Documentation Table of Contents

This page sets out the analysis and draft table of contents for Status.net documentation.

This is based on Documentation Audiences (this it sets out the various audiences for the documentation, their requirements and the documentation that will support these).

Getting started guide

Description: Help for people getting started with status.net - quick task focused documentation. More advanced documentation covered in detailed user handbook.

Audiences:

• People new to using status.net
• People who want to find out what the can do with status.net
• Quick answers to common tasks

Approach: Task focused, help new people get perform basic activities, quickly find the answer to basic questions, all getting started information in one place.

Task/procedures and knowledge topics:

Table of contents:

• Comparison between status.net and Twitter
• Screen shot with a description of the main elements

User guide

Description:

Audiences:

Approach:

Tasks/procedures and knowledge topics:

Tasks/procedures	Knowledge
Your account Creating an account Customising your account - cover here or in user handbook? Uploading an avatar Displaying your tags Theming your profile Your profile Deleting my account	Terms used: attachment dent??? notice?? vs post vs message tag terms - hash tag, group tag public timeline vs public stream vs front page What is status.net Why should I use you? How can I use it? How is it different from Twitter etc
Posting a message Including links in your post - URL shortening services Adding a picture, video or document to your post
Tagging your message/post hash tags # = categorise your post by topics friend tags @# = sends your post only to the people your have categorised with this tag self tags????? group tags ! = post to an already establish group (do you have to be a member??? hash vs bang = what the hell is a bang?????
Viewing posts as a 'conversation' - in context
Using your account with Twitter Using Twitter with status.net Automatic posting from status.net to twitter Importing your followers from twitter
Using status.net with other services: Twitter Facebook Mobile phone Your blog
Following other people Subscribing to people on other status.net servers (remote subscriptions)
Keeping track of great messages - favourites
Searching Basic searching Advanced searching
Getting followers Inviting other people to create an account on status.net
Blocking people
Dealing with spam
Using plugins What are they Popular plugins
Getting help Post a message Email Forums?
Posting to status.net from other applications: Using instant messaging services to post messages to status.net Setting up your account details Sending updates Commands
Using groups: What they are Finding groups Subscribing to a group Posting to a group Unsubscribing from a group Creating a group Managing a group

Table of contents

• Introduction
  • What is status.net?
  • status.net features
  • What this guide covers
  • Conventions used in this guide
• Your account
  • Creating an account
  • Customising your account
    • Uploading an avatar
    • Displaying your tags
    • Theming your profile
  • Completing your profile
• Posting a notice
  • Including links in your post - URL shortening services
  • Adding a picture, video or document to your post
  • Tagging your message/post
    • hash tags # = categorise your post by topics
    • friend tags @# = sends your post only to the people your have categorised with this tag
    • self tags?????
    • group tags ! = post to an already establish group (do you have to be a member???
    • hash vs bang = what the hell is a bang?????
• Viewing posts as a 'conversation' - in context (maybe for advanced/user handbook)
• Using your account with Twitter
  • Using Twitter with status.net
    • Automatic posting from status.net to twitter
  • Importing your followers from twitter
• Using status.net with other services:
  • Twitter
  • Facebook
  • Mobile phone
  • Your blog
• Following other people
  • Keeping track of great messages - favourites
• Searching
• Getting followers
• Blocking people
• Dealing with spam
• Using plugins
  • What are they
  • Popular plugins
• Getting help
  • Post a message
  • Email