Skip to end of metadata
Go to start of metadata

<h1>Zend Framework Translator - English Editors Team</h1>

<p>Responsible for enhancements, additions, corrections, editing submissions, and making sure the manual covers new features and committed code changes. To contribute, please see the brief <a href="http://framework.zend.com/wiki/display/ZFDEV/Documentation+Standard">Documentation Standard</a>.</p>

<p>Would you like to contribute and help the English documentation team? Please submit a CLA, and contact the team on the Zend Framework documentation list fw-docs@lists.zend.com <ac:emoticon ac:name="smile" /></p>

<h2>English fluency is <span style="text-decoration: underline;">not</span> required!</h2>
<p>Some of these tasks do <strong>not</strong> require fluency in English, so all documentation team members are encouraged to help with the English manual. In many cases, if the English wording in the manual is confusing to a non-native English speaker, then that part of the manual is suspect and should be reviewed by a fluent English speaker. I think having more non-native English speakers on the English documentation team would greatly benefit everyone, because non-native speakers often find idiomatic phrases that are confusing or unnecessary, and they help make documentation more concise and less ambiguous. English editors can easily correct the minor grammatic variances later.</p>

<h2>We are looking for people to:</h2>
<ol>
<li>Help monitor our Issue Tracker for documentation-related issues and help resolve them.</li>
<li>Build out the team's wiki pages (including the Documentation Team's Homepage).</li>
<li>Monitor the mailing list for Q & A provided by the community that should be added to the manual (<a href="http://framework.zend.com/wiki/display/ZFMLGEN/mail/1404">example</a>)</li>
<li>Monitor the wiki version of the manual for helpful comments (submitted by users) to edit and include into the manual.</li>
<li>Proofreading/survey/review of existing documentation to discover and <strong>document</strong> problem/missing areas by editing this wiki page.</li>
<li>Search for under-represented components with insufficient documentation.</li>
<li>Also, to fill in any "holes", team members may want to solicit code examples and improvements from the community of ZF developers that have signed the CLA. These "snippets" of documentation could then be added to the manual.</li>
</ol>

<h2>Team members</h2>
<ul>
<li><ac:link><ri:user ri:username="darby" /></ac:link></li>
<li><ac:link><ri:user ri:username="gavin" /></ac:link></li>
<li><ac:link><ri:user ri:username="LukeRichards" /></ac:link></li>
<li><ac:link><ri:user ri:username="nicklo" /></ac:link></li>
<li><ac:link><ri:user ri:username="andries" /></ac:link></li>
<li><ac:link><ri:user ri:username="cythrawll" /></ac:link></li>
<li>Component Leads - All component leads are required to lead the documentation effort for their component. Incubator components with insufficient documentation will <strong>not</strong> be moved to core.</li>
</ul>

<h2>Quick Links</h2>

<ul>
<li>The very latest version of the manual is found here:
<ul>
<li><a class="external-link" href="http://framework.zend.com/wiki/display/ZFDOCDEV/Home">http://framework.zend.com/wiki/display/ZFDOCDEV/Home</a> - Core component docs</li>
<li><a class="external-link" href="http://framework.zend.com/wiki/display/ZFDOC/Home">http://framework.zend.com/wiki/display/ZFDOC/Home</a> - Incubator component docs</li>
</ul>
</li>
<li><a class="external-link" href="http://framework.zend.com/wiki/display/ZFDEV/Documentation+Team">http://framework.zend.com/wiki/display/ZFDEV/Documentation+Team</a> - Project Team Homepage</li>
<li><a class="external-link" href="http://framework.zend.com/wiki/x/Ggw">http://framework.zend.com/wiki/x/Ggw</a> - English Doc Team Homepage - English Team Homepage</li>
</ul>

<h2>Tasks</h2>

<p>Pick a chapter, mark it in the wiki so that people know who is working on which ones, and then mark the chapter/section as done, when you complete.</p>
<ol>
<li>Most of the English manual needs to be edited for consistency and style.</li>
<li>Most of the newest components (in the incubator) need additional documentation written.</li>
<li>Many examples need improvement.</li>
<li>The source code in the ZF core should be scanned in parallel with the English manual, in order to determine which topics have not been adequately covered in the manual.</li>
<li>Incorporate these notes about how to make IIS work into the manual: <a class="external-link" href="http://framework.zend.com/issues/browse/ZF-288#action_10662">http://framework.zend.com/issues/browse/ZF-288#action_10662</a></li>
<li>Look through our Issue Tracker for any issues of type "Docs", such as <a class="external-link" href="http://framework.zend.com/issues/browse/ZF-243">http://framework.zend.com/issues/browse/ZF-243</a>, and either assign an issue to yourself and work on it, or unassign an issue that is assigned to yourself, if you prefer not to work on a particular issue.</li>
</ol>

<h2>Which chapters of the English manual need editing?</h2>
<ul>
<li>TODO: all</li>
<li>In Progress: none (replace with the list you are editing)</li>
<li>Completed: none (replace with the list you have finished editing, include date of completion for each chapter)</li>
</ul>

<h2>Which chapters of the English manual need proofreading?</h2>
<ul>
<li>TODO: all</li>
<li>In Progress: none (replace with the list you are editing)</li>
<li>Completed: none (replace with the list you have finished editing, include date of completion for each chapter)</li>
</ul>

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.