A readme file is an annotated table of contents. A good readme file should
Explain how the materials are structured and how that is similar to or different from the way they were structured in the original print materials.
List the names of the files and give the reader some idea of what each file contains.
Name any file folders and explain what is contained in each folder.
The following example is a readme file on a disk containing materials for an Accessible Practices Workshop.
This readme contains an annotated list of documents contained on this disk. These documents are part of a notebook of information provided to participants in the Accessible Practices Workshops run by the Association of Science-Technology Centers Incorporated (ASTC). This disk contains most of the materials included in the notebook, although some documents were unavailable to be put on disk. For a complete listing of notebook materials, go to the file entitled "Contents.txt" in the "0-Intro" folder.
The materials on this disk are divided into six folders. Titles and contents are described below. These sections parallel the sections in the notebook.
0-Intro. The introduction folder contains welcomes, general information about the Accessible Practices Project, and an article discussing the state of accessibility in science centers.
1-Activ. The folder on workshop activities and participants contains the workshop agenda; a page describing people-first language; lists of contact information for presenters, resource people, science center and ASTC staff involved in the Accessible Practices project, and workshop participants; and biographies of presenters, resource people, science center staff, and ASTC staff.
2-Mat&Tl. The materials and tools folder contains advice on accessibility from parents of children with disabilities, synopses of national accessibility laws, a list of contacts for state accessibility codes, tables with sample transition/implementation plans, and a chart that cross-references by topic each of four documents regarding accessibility in museums.
3-Impl. The implementation folder contains articles on staff training about access issues and inviting people with disabilities to act as advisors.
4-PR. The folder about public relations and marketing strategies contains advice from parents of children with disabilities, a checklist for outreach and promotion, and an article on writing an access guide.
5-Resrce. The resource folder contains information about ASTC's Accessible Practices Web Page and Annual Conference sessions, a suggested reading list, lists of regional and national resources, and a list of contact information for regional Disability and Business Technical Assistance Centers (DBTACs).
Following is an annotated list of the files contained in the folders on this disk. The files are listed below in the order they appear in the notebook.
Disclaim.txt contains the disclaimer, copyright and funder information for the Accessible Practices project.
Acknowl.txt acknowledges the individuals and organizations that have contributed to the Accessible Practices project.
Contents.txt lists all materials that are contained in the complete Accessible Practices Workshop Notebook.
VanDorn.txt is a welcome letter from Bonnie VanDorn, Executive Director of ASTC.
Project.txt describes the rationale behind the Accessible Practices Project and the various aspects of its implementation.
Dates.txt identifies the dates and hosting science centers for upcoming workshops.
Field.txt is an article entitled "Accessible Practices: A Report from the Field" that describes the results of a study investigating accessibility in science centers.
Agenda.txt outlines the agenda for the workshop.
Language.txt describes appropriate language when speaking about people with disabilities.
Contacts.txt lists contact information for workshop hosts, presenters, and advisors.
Bios.txt lists biographical sketches of hosts, presenters, and advisors.
Particip.txt lists contact information for workshop participants.
Parent1.txt shares advice from parents of children with disabilities on how to make science centers more accessible.
Synlaw.txt provides synopses of national accessibility laws pertinent to museums.
Statelaw.txt lists contact information for technical assistance on each state's accessibility codes.
Factsh-2.txt discusses various auxiliary aids and services.
Checklst.txt provides a checklist and suggested solutions for existing facilities.
Crossref.txt cross-references the pages where selected topics are discussed in four different accessibility checklists and guidelines.
Smplplan.txt provides three sample excerpts from transition/implementation plans.
Blnkplan.txt is a blank worksheet for creating your own transition/implementation plan.
Trainstf.txt gives tips on training staff about accessibility.
Advisors.txt provides advice about recruiting and working with people with disabilities as advisors and shares feedback from museum practitioners who have worked with such advisors.
Parentpr.txt shares advice from parents of children with disabilities about public relations.
Outreach.txt is a checklist for outreach and promotion activities.
Accguide.txt explains what an access guide is and shares advice from practitioners.
Webpage.txt describes what can be found on ASTC's Accessible Practices Web Pages.
Conferen.txt describes workshops and sessions to be held at the ASTC Annual Conference.
Readings.txt lists suggested readings on accessibility and museums.
Regional.txt lists contact information for regional organizations that deal with issues of accessibility.
DBTAC.txt explains what the Disability and Business Technical Assistance Centers are and lists regional contact information.
National.txt lists contact information for national organizations that deal with issues of accessibility.
This web site is not intended to offer legal, architectural, engineering, or similar professional advice. Refer specific questions to an attorney or an ADA authority.