Create a new specification

Why create a new specification?

When we make open source software we depend on many patterns, ways of doing things. There are good and bad designs. If you can document your design and get other people to use it in their software, chances are it'll become better. Specifications can be for "a protocol, a process, an API, a use of language, or any other aspect of a technical environment that can usefully be documented for the purposes of technical or social interoperability", to quote the Consensus-Oriented Specification System.

Naming conventions

Specifications are numbered, but this happens automatically when you create them. You need to choose a name for the spec, and an abbreviation. This just makes it easier for people to refer to the spec. The title of the spec is "<abbreviation> - <name>". You refer to it as "www.restms.org/spec:<number>/<abbreviation>" or "<number>/<abbreviation>".

Prerequisites

Before you can create a new spec, you must be registered as an editor. You have to read and agree with the terms of use and intellectual property policy of this site. You need to be registered as a Wikidot user (this site is hosted on Wikidot). And you should join the mailing list.

It's your baby

If you start a new specification, you're responsible for it. That means you are the editor, and the only editor of the page. If this is too much responsibility for you, ask the public mailing list for help. The only way to change the editor of an existing specification is to fork it and delete the old one. "Delete" means "tag with the deleted tag". No specs are actually deleted.

Tagging

Untagged specs are considered "raw". When you have running code, tag the spec as "draft". When you have real users, tag it as "stable". When you have production users and are thinking of a new version, tag it "legacy". When you have replaced it with a new spec, tag the old one "retired". If you decide you want to abandon a raw or draft spec, tag it "deleted".

Go for it

Choose a good name for your spec, and enter the "<abbreviation> - <name>" below. You can change the name later. When you click "Create", you'll get a template for the new spec. Enter the information you can, save the page. For heavy editing work, usually it's easiest to work offline, using a text editor, and then paste your work back into the wiki page.

Recent edits

spec:2/RestMS - a RESTful Messaging Service
(29 Mar 2012 12:43)
main:Start
(15 Nov 2010 08:04)
article:RestMS Presentation at FrOSCon 2009
(24 Aug 2009 06:46)
issue:1 - Perl Client - Samples - News Subscriber/Publisher problem
(01 Jun 2009 07:16)
nav:Side
(21 May 2009 08:48)
article:Introduction to RestMS
(18 May 2009 08:03)
style:Column Divider
(17 May 2009 16:00)
article:Twitter for Applications
(16 May 2009 12:07)
wiki:Housecat
(07 May 2009 12:52)
wiki:Reverse Housecat
(07 May 2009 12:50)
main:Discussion
(05 May 2009 14:02)
chatter:Lightning talk at Euro DjangoCon
(05 May 2009 13:19)
main:Getting Started
(05 May 2009 13:03)
chatter:RestMS presentation
(30 Apr 2009 05:17)
wiki:Wolf Call
(26 Apr 2009 13:43)
wiki:Wolfpack
(26 Apr 2009 13:42)
wiki:Parrot
(26 Apr 2009 13:42)
wiki:TELNET
(15 Apr 2009 12:20)
wiki:Profile
(15 Apr 2009 12:19)
talk:RestMS
(15 Apr 2009 06:53)