GFM changes
This commit is contained in:
William Sandner
parent
539106de83
commit
e8ea275fa2
@ -1,151 +0,0 @@
|
|||||||
### Mission
|
|
||||||
- [Browse templates](https://github.com/bike-bill/readyset-markdown)
|
|
||||||
- [Download markdown templates](https://github.com/bike-bill/readyset-markdown)
|
|
||||||
or [Download original templates](http://readyset.tigris.org/servlets/ProjectDocumentList)
|
|
||||||
- [Words-of-wisdom](http://readyset.tigris.org/words-of-wisdom/)
|
|
||||||
- [Professional version](http://www.readysetpro.com/)
|
|
||||||
|
|
||||||
#### What problem does this project address?
|
|
||||||
|
|
||||||
Software development projects require a lot of "paperwork" in the
|
|
||||||
form of requirements documents, design documents, test plans,
|
|
||||||
schedules, checklists, release notes, etc. It seems that everyone
|
|
||||||
creates the documents from a blank page, from the documents used on
|
|
||||||
their last project, or from one of a handful of high-priced
|
|
||||||
proprietary software engineering template libraries. For those of us
|
|
||||||
who start from a blank page, it can be a lot of work and it is easy
|
|
||||||
to forget important parts. That is not a very reliable basis for
|
|
||||||
professional engineering projects.
|
|
||||||
|
|
||||||
#### What is the goal of this project?
|
|
||||||
|
|
||||||
ReadySET is an open source project to produce and maintain a library
|
|
||||||
of reusable software engineering document templates. These templates
|
|
||||||
provide a ready starting point for the documents used in software
|
|
||||||
development projects. Using good templates can help developers work
|
|
||||||
more quickly, but they also help to prompt discussion and
|
|
||||||
avoid oversights.
|
|
||||||
|
|
||||||
#### What are some key features that define the product?
|
|
||||||
|
|
||||||
High-quality outlines, sample text, and checklists.
|
|
||||||
|
|
||||||
- Uses simple web technologies: Pure XHTML and CSS (or alternatively Markdown).
|
|
||||||
- Templates for *many* common software engineering documents. Including:
|
|
||||||
- Project proposal template
|
|
||||||
- Project plan template
|
|
||||||
- Use case template
|
|
||||||
- QA plan template
|
|
||||||
- Several design templates
|
|
||||||
- System test case template
|
|
||||||
- Release checklist template
|
|
||||||
|
|
||||||
#### What makes this product different from others?
|
|
||||||
|
|
||||||
This is an open source project that you are welcome to use for free
|
|
||||||
and help make better. Existing packages of software engineering
|
|
||||||
templates are highly costly and biased by the authorship of only a
|
|
||||||
few people, by vendor-client relationships, or by the set of tools
|
|
||||||
offered by a particular vendor.
|
|
||||||
|
|
||||||
These templates are in pure XHTML with CSS (or Markdown), not a proprietary
|
|
||||||
file format. That makes them easier to edit and to track changes
|
|
||||||
using freely available tools and version control systems. The
|
|
||||||
templates are designed to always be used on the web; they use
|
|
||||||
hyperlinks to avoid duplicating information.
|
|
||||||
|
|
||||||
The templates are not burdened with information about individual
|
|
||||||
authorship or document change history. It is assumed that
|
|
||||||
professional software developers will keep all project documents in
|
|
||||||
version control systems that provide those capabilities.
|
|
||||||
|
|
||||||
These templates are not one-size-fits-all and they do not attempt to
|
|
||||||
provide prescriptive guidance on the overall development process. We
|
|
||||||
are developing a broad library of template modules for many purposes
|
|
||||||
and processes. The templates may be filled out in a suggested
|
|
||||||
sequence or in any sequence that fits your existing process. They
|
|
||||||
may be easily customized with any text or HTML editor.
|
|
||||||
|
|
||||||
### Scope
|
|
||||||
|
|
||||||
#### What is the scope of this project?
|
|
||||||
|
|
||||||
We will build templates for common software engineering documents
|
|
||||||
inspired by our own exprience.
|
|
||||||
|
|
||||||
#### What are the high-level assumptions or ground rules for the project?
|
|
||||||
|
|
||||||
I assume that the user takes ultimate responsibility for the content
|
|
||||||
of all their actual project documents. The templates are merely
|
|
||||||
starting points and low-level guidance.
|
|
||||||
|
|
||||||
#### What are we not going to do?
|
|
||||||
|
|
||||||
This project does not attempt to provide powerful tools for
|
|
||||||
reorganizing the templates, mapping them to a given software
|
|
||||||
development process, or generating templates from a underlying
|
|
||||||
process model. This project does not include any application code
|
|
||||||
for any tools, users simply use text editors to fill in or customize
|
|
||||||
the templates.
|
|
||||||
|
|
||||||
#### Is this project part of a larger effort?
|
|
||||||
|
|
||||||
Yes. It is part of the Tigris.org mission of promoting open source
|
|
||||||
software engineering. It is also the first product in a product line
|
|
||||||
that will provide even better support to professional
|
|
||||||
software developers. For more information, see
|
|
||||||
[ReadySET Pro](http://www.readysetpro.com).
|
|
||||||
|
|
||||||
### Status
|
|
||||||
|
|
||||||
#### What is the status of this project?
|
|
||||||
|
|
||||||
- These templates are based on templates originally used to teach
|
|
||||||
software engineering in a university project course. They are now
|
|
||||||
being enhanced, expanded, and used more widely by professionals
|
|
||||||
in industry.
|
|
||||||
- The template set is fairly complete and ready for use in real projects.
|
|
||||||
You can [download](http://readyset.tigris.org/servlets/ProjectDocumentList)
|
|
||||||
recent releases. We welcome your feedback.
|
|
||||||
- For the latest news, see the
|
|
||||||
[Project Announcements](http://readyset.tigris.org/servlets/ProjectNewsList).
|
|
||||||
|
|
||||||
### Applicability
|
|
||||||
|
|
||||||
#### Who should use this product?
|
|
||||||
|
|
||||||
ReadySET is aimed at software engineers who wish that their projects
|
|
||||||
could go more smoothly and professionally. ReadySET can be used by
|
|
||||||
anyone who is able to use an HTML editor or edit HTML in a
|
|
||||||
text editor.
|
|
||||||
|
|
||||||
#### How can users get started?
|
|
||||||
|
|
||||||
1. Briefly [browse all templates](https://github.com/bike-bill/readyset-markdown)
|
|
||||||
2. [Download markdown templates](https://github.com/bike-bill/readyset-markdown)
|
|
||||||
or [Download original templates](http://readyset.tigris.org/servlets/ProjectDocumentList)
|
|
||||||
the templates and unarchive
|
|
||||||
3. Edit the templates to fit the needs of your project
|
|
||||||
4. Place the templates on a web server where all your project
|
|
||||||
stakeholders can view them
|
|
||||||
5. Edit the templates to fill in detailed information
|
|
||||||
- Use a text editor or an HTML editor. Please see our list of
|
|
||||||
[recommended tools](docs/recommended-tools). (You can
|
|
||||||
use Word, but that is strongly discouraged.)
|
|
||||||
- Follow instructions that appead in yellow "sticky notes", TODO, or TIPS sections
|
|
||||||
- Replace text in ALL CAPS and lines that start with :: (double colons)
|
|
||||||
with text that describes your project
|
|
||||||
- [Chip away](docs/faq.html#chipaway)" text that does not
|
|
||||||
apply to your project
|
|
||||||
- Add text, diagrams, or links as needed
|
|
||||||
6. Use the checklists to catch common errors and improve the
|
|
||||||
quality of your documents.
|
|
||||||
7. Use the words-of-wisdom pages to help improve the document or
|
|
||||||
deepen your understanding of relevant issues.
|
|
||||||
8. Optionally, you may change fonts and colors in the
|
|
||||||
file css/inst.css.
|
|
||||||
9. If you have questions or insights about a templates, please read
|
|
||||||
the [FAQ](docs/faq.html) or send an email to
|
|
||||||
<dev@readyset.tigris.org>. You must subscribe to the mailing
|
|
||||||
list before you may post.
|
|
||||||
|
|
||||||
@ -1,80 +0,0 @@
|
|||||||
|
|
||||||
Do not modify or delete this file. This file describes the license under
|
|
||||||
which you may use the ReadySET templates.
|
|
||||||
|
|
||||||
### Copyright and License
|
|
||||||
|
|
||||||
Copyright (C) 2003-2004 Jason Robbins. All rights reserved.
|
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
|
||||||
modification, are permitted provided that the following conditions
|
|
||||||
are met:
|
|
||||||
|
|
||||||
1. Redistributions of these files must retain the above copyright
|
|
||||||
notice, this list of conditions and the following disclaimer. The
|
|
||||||
individual template files must retain the copyright footnote whenever
|
|
||||||
they are used as templates.
|
|
||||||
|
|
||||||
2. The name "ReadySET" must not be used to endorse or promote
|
|
||||||
products derived from this software without prior written
|
|
||||||
permission. For written permission, please contact
|
|
||||||
jrobbins@jrobbins.org.
|
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
|
|
||||||
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
||||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
||||||
IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY DIRECT,
|
|
||||||
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
||||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
||||||
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
||||||
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
||||||
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
|
|
||||||
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
||||||
POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
|
|
||||||
### License FAQ
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
#### Can I use these templates at my company?
|
|
||||||
|
|
||||||
Yes, absolutely. Once you fill in the template with detailed
|
|
||||||
information about a specific project, you are free to do what you
|
|
||||||
want with them in the context of that project. ***You may even hide the
|
|
||||||
template copyright statement***: the best way to do that is to edit the
|
|
||||||
file inst.css.
|
|
||||||
|
|
||||||
#### Can I modify these templates for use on several projects at my company?
|
|
||||||
|
|
||||||
Yes, absolutely. You may modify and distribute these templates to
|
|
||||||
others, so long as you retain this file and the footnote with the
|
|
||||||
copyright statement clearly visible in each file.
|
|
||||||
|
|
||||||
#### Can I include these templates as part of a commercial product?
|
|
||||||
|
|
||||||
If you use the templates and fill in details about a given product,
|
|
||||||
go ahead. If you are thinking of making a product that includes the
|
|
||||||
templates for use *as templates*, you must retain this file and the
|
|
||||||
copyright statement in a visible footnote. An enhanced commercial
|
|
||||||
version of these templates, [ReadySETPro](http://www.readysetpro.com/),
|
|
||||||
is already in development
|
|
||||||
|
|
||||||
#### Can I combine these templates with other templates or documents?
|
|
||||||
|
|
||||||
Sure, go ahead. This license is not "viral", it does not mean that
|
|
||||||
anything you do must be open source or covered under the
|
|
||||||
same license.
|
|
||||||
|
|
||||||
#### If I enhance the templates, must I give those enhancements back to the open source project?
|
|
||||||
|
|
||||||
No, but it would be very welcome. Even if you don't modify the
|
|
||||||
templates, you can share your "words of wisdom". For more
|
|
||||||
information on contributing, see the
|
|
||||||
[ReadySET home page](http://readyset.tigris.org/).
|
|
||||||
|
|
||||||
#### ReadySET seems too good to be true. What is the catch? Why would anyone buy a commercial version?
|
|
||||||
|
|
||||||
There is no catch. However, the scope of ReadySET is limited to only
|
|
||||||
most common needs of development projects. It is easy to get started
|
|
||||||
with ReadySET, but [ReadySET Pro](http://www.readysetpro.com/) holds
|
|
||||||
much more value for corporate users.
|
|
||||||
@ -119,5 +119,5 @@
|
|||||||
### How to download these templates:
|
### How to download these templates:
|
||||||
- [Download template archive](http://readyset.tigris.org/servlets/ProjectDocumentList), or
|
- [Download template archive](http://readyset.tigris.org/servlets/ProjectDocumentList), or
|
||||||
- Use CVS to [check out](http://readyset.tigris.org/servlets/ProjectSource) project
|
- Use CVS to [check out](http://readyset.tigris.org/servlets/ProjectSource) project
|
||||||
"readyset" or Download from [ReadySet GFM](https://github.com/bike-bill/readyset-gfm)
|
"readyset" or clone from [ReadySet GFM](https://github.com/bike-bill/readyset-gfm.wiki.git)
|
||||||
on Github.
|
on Github.
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user