Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 68 lines (42 sloc) 2.787 kb
51384b7 @dhoss initial commit finally, of epo proposal
dhoss authored
1 EPO POE Doc Grant Proposal
2 --------------------------
3
26fc9b1 @rcaputo Made the EPO proposal a little more "this is what we're going to do"-ish...
authored
4 Abstract:
5
6 POE is large, and its existing documentation is not gentle to new
7 users. This grant will fund the creation of documents that introduce
8 new users to POE's basic and intermediate concepts and their usage.
51384b7 @dhoss initial commit finally, of epo proposal
dhoss authored
9
10 Deliverables:
11
26fc9b1 @rcaputo Made the EPO proposal a little more "this is what we're going to do"-ish...
authored
12 1. An organized outline of topics that will serve as a specification
13 for the final deliverable documentation. The outline will be
14 submitted to EPO for approval before writing begins.
51384b7 @dhoss initial commit finally, of epo proposal
dhoss authored
15
26fc9b1 @rcaputo Made the EPO proposal a little more "this is what we're going to do"-ish...
authored
16 2. Documents per the topical outline.
17
18 Involved:
51384b7 @dhoss initial commit finally, of epo proposal
dhoss authored
19
26fc9b1 @rcaputo Made the EPO proposal a little more "this is what we're going to do"-ish...
authored
20 Rocco Caputo <rcaputo@cpan.org> - Mentor/Manager
a901328 @dhoss fleshed out proposal doc
dhoss authored
21 Devin Austin <dhoss@cpan.org> - Student/Writer
22
23 Project Plans:
24
edd79cc @rcaputo Minor cleanups.
authored
25 1. Triage current documentation to bridge the gap between where the documentation is now, and where we want to be by the end (already in progress).
a901328 @dhoss fleshed out proposal doc
dhoss authored
26
edd79cc @rcaputo Minor cleanups.
authored
27 2. Analyze what kind of examples that would be most beneficial to include in the documentation.
a901328 @dhoss fleshed out proposal doc
dhoss authored
28
edd79cc @rcaputo Minor cleanups.
authored
29 3. Refactor documentation into a usable state.
a901328 @dhoss fleshed out proposal doc
dhoss authored
30
edd79cc @rcaputo Minor cleanups.
authored
31 4. Create a well rounded and user friendly document and code base for the beginning POE user.
a901328 @dhoss fleshed out proposal doc
dhoss authored
32
33 5. "Beta" test documentation through various trials and get feedback on what needs fixing, applause, comments, etc.
34
edd79cc @rcaputo Minor cleanups.
authored
35 6. Send out an RFC to the POE and other respective mailing lists concerning the new documentation.
a901328 @dhoss fleshed out proposal doc
dhoss authored
36
edd79cc @rcaputo Minor cleanups.
authored
37 7. Sift through RFC feedback and continue the refactoring cycle.
a901328 @dhoss fleshed out proposal doc
dhoss authored
38
39 8. Finalize documentation and examples and have a finished and brand new documentation product for the new POE user.
40
41 Project Schedule: (not sure what we're looking at here for a due date, will leave this out until we figure that out)
42
edd79cc @rcaputo Minor cleanups.
authored
43 Benefits to the perl/open source community:
44
a901328 @dhoss fleshed out proposal doc
dhoss authored
45 POE is a very useful framework for many many tasks. If we can bridge the gap between the new user and the current user-base, it will help bring POE into a less "scary" light, much in the way that Moose's doc grant brought a large influx of interested users into the fray. With an influx of users comes volunteers, which means better documentation, better tests, and more hands for expanding POE itself.
46
47 Milestones:
edd79cc @rcaputo Minor cleanups.
authored
48
a901328 @dhoss fleshed out proposal doc
dhoss authored
49 0. RFC to mailing list for documentation wishes
50 1. Full wishlist of TODOs (mostly done)
51 2. Fulfillable task list which we will focus on
52 3. First draft/round of completed documentation and examples (perhaps by "chapter?")
53 4. Nth draft/round of completed documentation and examples (will be based upon how the documentation will be stair stepped)
54 5. Initial trials for reviews
55 6. RFC to mailing list
56 7. Integration of mailing list reviews
57 8. RFC of integrated and finalized documentation
58
59 Bio:
edd79cc @rcaputo Minor cleanups.
authored
60
a901328 @dhoss fleshed out proposal doc
dhoss authored
61 22 year old student/web development contractor in the final throes of a Computer Security degree with a minor in Computer science. Kung Fu instructor in-progress, and avid perl hacker and geek.
62
63 Accomplishments:
64 Google Summer of Code 2009
65 http://search.cpan.org/~dhoss
66
67 License: Perl 5
Something went wrong with that request. Please try again.