Liberty Miller - TECHNICAL COMMUNICATIONS 61 -
Fall Quarter 1997
"On-line Guide for Beginning HTML"
This Documentation Plan is meant to outline the features and characteristics of the "On-line Guide for Beginning HTML" project for all groups involved in its production. This Documentation Plan has been developed as an exercise for the Technical Communications 61 class. Published elements are hyperlinked below.
This document is meant to be a non-profit public service, accessible to all. To that end, it will be published on the World Wide Web.
As intimated in its title, the "On-line Guide for Beginning HTML" is intended for users new to HyperText Markup Language (HTML). We will assume the document will be used to create basic web pages by users who have some familiarity with the World Wide Web, popular browsers, and with computers in general.
Media & Style
Since this document is to be published on the WWW (World Wide Web), it will be written in HTML. All pages should be written with the assumption that the HTML code will be frequently checked by the user as an additional reference and learning aid. Style templates will be created by the writers to establish a consistent look and feel to the document, following the basic style guidelines listed below. Consideration of a potential "hard-copy" version of the document must be included.
Target Audience & Excluded Content
The Web is already full of many useful sites dedicated to introducing users to the features and intent of the Internet. To be useful, our document must attempt to fill a specific informative niche. We will describe our intent to the reader in an introduction to the site, including information we will not be covering. A list of links to potentially informative and/or helpful sites, and a list of related books, may be provided, depending on previous experience of the writers and time available to do research.
All chapters are to be written in a consistent style. This formatting style will be determined at a meeting of the technical writers after a review of all salient technical features that need to be included. (See also the basic style features that follow.)
Basic Style Features
Serves as "Home Page" for the site.
Introduction: A description of the document/site, what it is meant to cover, links to other potentially useful sites and other recommended references.
Table of Contents: List of "Chapters," pages, and sub-sections, with hyperlinks to each.
Explains the basic terms used in HTML and provides the necessary tags for your first HTML document.
A "hello world" page. Includes "Dividing your web page into sections", "Titles", and Footer suggestions.
Demonstrates the headings, division, and paragraph tags, and provides examples of various tags used depending on the nature of the text presented. Expands on page layout.
3.1 Content-Based Style Tags
3.2 Physical Style Tags
3.3 Setting Font Sizes
3.4 Changing Font Types
Shows special characters and how to use ASCII codes.
Explains how to insert HTML pointers to external Web and Internet resources, and to internal elements of your Web pages. Includes anchors and image links.
5.1 Types of Links
5.2 Creating Links
5.3 Internal Document References
Discusses various types of lists for Web documents, including numbered lists, bullet lists, and definition lists.
Describes background and text colors available.
7.1 Types of Color
7.2 Adding Color
8.1 Types of Images
8.2 Image Alignment Options
8.3 Using Graphics for Backgrounds
Explains how to set up links within an image, with possible applications.
10.1 : Uses for Tables in Web Pages
10.2 : Basic Table Elements
10.3 : Table Borders and Alignment
10.4 : "Table Data" & Columns
10.5 : Captions and Headings
10.6 : Cell Alignment & Spacing
10.7 : Colors
11.1 Changing a Frames Contents
12.1 Creating and Identifying Form Parts and Information
12.2 Adding Submit and Reset Buttons
12.3 Adding Input Fields
12.4 Check Boxes
12.5 Radio Buttons
12.6 Select Lists
12.7 Text Areas
12.8 Field Sets
Outlines MetaTag requirements and uses.
Describes the main types of styles sheets and their properties.
Defines the terms and provides two practical examples.
A collection of each chapter's main points and Tags for review.
A list of references which can help expand upon this document or are related to this topic, in print or on the Web, with appropriate hyperlinks.
The main "new" terms and/or jargon used throughout the document.
Listing of all main terms and ideas introduced in this document, with Chapter/Section numbers and hyperlinks to the applicable sections.
Ideally, the total memory space of the document should not be more than 2 Mb of data, but can reach a maximum of 5 Mb. This implies a limit of around 100 Kb per section: any Chapter exceeding this limit should be approved by Optimus Primal.
As we are working on multiple projects at this time (including the Ancient Greece project, the Advanced HTML project, the Painting project, filing taxes, and others) it is essential that this project be initiated and completed as soon as possible. A scheduling session is imperative!
[This document was written by Liberty Miller ( ã 1997), originally using Microsoft Word 97 SR-1, then hand-coded into HTML]