Grant Report: Establishing Documentation Standards for the Perl 7 Era, September 2020
Thu, 08-Oct-2020 by
Jason A. Crome
edit post
Nicolas R. has shared Jason McIntosh's updates for September for the Establishing Documentation Standards for the Perl 7 Era grant:
> Major steps towards my goal accomplished in September:
>
> * Announced my starting this project on #p5p on Freenode, and collecting some basic information there
>
> * Gathering Perl’s documentation style & policy information (of which there ain’t much, of course, hence the present project)
>
> * Touring other FOSS languages and technologies with their own documentation sub-projects, and comparing them to what Perl has. Projects studied so far include Python, Rust, Raku, and Linux's "man-pages”.
>
> * Have started to introduce myself to some of the above projects’ online communities, looking to make some contacts in their respective docs teams
Regarding the [governance conversation](https://perl.topicbox.com/groups/gov-begin) started last month:
> I’ve skimmed the ongoing discussion and action there, and see that the floor is shifting at this very moment regarding the way that Perl gets developed and maintained in the future. By the same token, I’m glad to see the possessors of the multiple visions for Perl’s future showing up to do the hard work of discussing and compromising and forging new, lasting agreements towards a set of common goals.
>
> I intend to continue paying attention to this work, as it seems likely that I’ll want to work this nascent governing body into the delivery phase of my own project.
Comments (1)
Please do not do this. 50 more hours of work versus the many millions of unpaid hours that have already gone into this subject will make no difference. A better approach might be to enable a documentation string to be associated with every package, function, parameter, variable and operator with methods for reading them as per the competition. This imbedded data could then be used to drive automation: documentation, indexing, consistency checking, linting, code generation etc. transcending, in doing so, any specific application.