Hi,

I thought that perhaps the initial description was a little terse, so
here is some more information:


Who uses PhraseBooks and why?
-----------------------------

An individual may use PhraseBook to keep a collection of their
personal compound commands(called 'tricks'), and tricks they obtain
from other Phrasebooks or as individual items.

A business can use PhraseBook to organise tricks pertaining to
particular IT tasks or positions, and to provide organisational
memory, and a dictionary of processes used.

A community can use PhraseBook to pool effort and quality check tricks
for use with their personal project or the product their community
uses or produces.

PhraseBook is a communication tool & vault and specifically aims to
provide a structure that enables a community to keep track of, and
organise crowd-sourced tricks.

Who better to design an user interface than the user community
themselves?


Use Case (and the original motivation for this idea)
----------------------------------------------------

The other day on svn-dev mailing list, a user requested a Subversion
feature to show the current revision number.

Subversion didn't need a new feature, and whilst the solution _looks_
simple, it wasn't all that obvious either:

svn info | sed -ne 's/Last Changed Revision: //p'

We helped one user to a solution, but packaging the above trick into

--svn-show-revision-number

would help all users, and also a list of such tricks would inspire
users to make full use of svn's capabilities they so far have been
unaware of.  The problem is a) how to share this efficiently b) how to
keep those shared tricks up-to-date!

If we can package the above as a trick together with a test, and
present it in an accessible form, then all our users will have access
to this knowledge and the trick can be automatically checked to see if
it's still functional for every SVN release, and users can build up a
compendium that educates, and works for, the entire community,
(reasonably) realiably so.

Ideally, the svn-user community on IRC will be able to use the Apache
voting process and tools to produce and maintain proven PhraseBooks
containing fully tested tricks which pertain to particular Subversion
releases.

Building a community to create PhraseBook
-----------------------------------------

The actual implementation of PhraseBook is reasonably trivial, but to
create a design that will keep users and the data they produce and
want to use safe, is anything but.

Thus spake Cassandra: "One user is difficult, two users gets tough,
an unlimited amount of users with unlimited freedom to do whatever
they want to do (some of which may be malicious!) is quite the tall
order."

Most of the work to be done will be discussing the many ways this can
go wrong and the task will be to create a forum that takes pleasure in
ruthlessly dissecting the design until it coalesces into what it could
and should be.

The prize we can win if we can get this right, is to create a tool
that will end up saving the entire IT community millions of man hours.

And, if anyone can make this happen, the Apache community can.

regards,

Gabriela

Ps.: I am as interested in opinions as to why this will not work, as I
am in ways of getting this done.  A gently, but firmly wielded
precision sledgehammer is the perfect design tool for this project!

The full proposal can be viewed here:
https://docs.google.com/document/d/1v1Y0qYI30jSzNNN-VyNTdORjY-d0B_uPLU62Ao4FuEI/pub


On Thu, Dec 12, 2013 at 10:28 AM, Gabriela Gibson <gabriela.gib...@gmail.com
> wrote:

> Hi,
>
> I would like to request an Apache Lab for my project idea.
>
> regards,
>
> Gabriela Gibson (g...@apache.org)
>
> PhraseBook is a tool for individuals, business and crowds to organize and
> maintain a personal or community-owned compendium of compound commands and
> scripts, which can be standardized, shared, tracked and searched due to
> having a general compatible format and inbuilt tests.
>
> It is not tied to any particular operating system or software, it is a
> general tool to keep our working methods organized and to enable us to
> share and preserve them.
>
> <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"; xmlns="
> http://usefulinc.com/ns/doap#"; xmlns:foaf="http://xmlns.com/foaf/0.1/";
> xmlns:labs="http://labs.apache.org/doap-ext/1.0#"; xmlns:projects="
> http://projects.apache.org/ns/asfext#
> "> <Project rdf:about="http://labs.apache.org/labs#phrasebook";>
> <name>PhraseBook</name> <shortname>phrasebook</shortname> <shortdesc
> xml:lang="en">A management tool for compound commands and
> scripts</shortdesc> <description xml:lang="en">PhraseBook is tool for
> individuals, business and crowds to organize and maintain a personal or
> community-owned compendium of compound commands and scripts, which can be
> standardized, shared, tracked and searched due to having a general
> compatible format and inbuilt tests. It is not tied to any particular
> operating system or software, it is a general tool to keep our working
> methods organized and to enable us to share and preserve
> them.</description> <homepage rdf:resource="
> http://labs.apache.org/phrasebook/"/> <license rdf:resource="
> http://usefulinc.com/doap/licenses/asl20"/> <created>2013-12-11</created>
> <labs:status>active</labs:status> <maintainer> <foaf:Person rdf:about="
> http://people.apache.org/~g...@apache.org/#me";> <foaf:name>Gabriela
> Gibson</foaf:name> <foaf:homepage rdf:resource="
> http://people.apache.org/~g...@apache.org/"/>
> <foaf:mbox_sha1sum>2b1d3fe2616b1bc422d4e7bec36af5f535638ec7</foaf:mbox_sha1sum>
> </foaf:Person> </maintainer> <repository> <SVNRepository> <location
> rdf:resource="http://svn.apache.org/repos/asf/labs/phrasebook/"/> <browse
> rdf:resource="http://svn.apache.org/viewvc/labs/phrasebook/"/>
> </SVNRepository> </repository>
> <programming-language>Python</programming-language>
> <programming-language>perl</programming-language>
> <programming-language>ruby</programming-language> <projects:implements>
> <projects:Standard> <projects:id>PhraseBook</projects:id>
> <projects:title>Command and Script Management Tool</projects:title>
> <projects:body>Apache</projects:body> <projects:url rdf:resource="
> http://apache.org/PhraseBook"/> </projects:Standard>
> </projects:implements> </Project> </rdf:RDF>
>
>
> --
> Visit my Coding Diary: http://gabriela-gibson.blogspot.com/
>



-- 
Visit my Coding Diary: http://gabriela-gibson.blogspot.com/

Reply via email to