Developer Center Resources

Showing results for 
Search instead for 
Did you mean: 

Template for Readme Document

» Product Documentation » Template for Readme Document


This document contains a template for creating a Readme document for a product.  Please make use of this documentation tool to create a readme document to accompany your product installer in order to provide pre-installation support for customers.



To make use of this document, download the attached readme.html file and use an HTML editor to edit the document.  I prefer using an open-source HTML editor called KompoZer for this purpose.


I have identified the sections or words in the document you will want to edit with brackets ([...]).  For example, you can do a Find and Replace for [ProductName] to change all of the text in the document to your product...



Please report any comments, recommendations, or questions as comments on this page below.