利用者:Brita/Projects/Documentation

Blender Documentation Tasks

Here I propose some tasks that I could do part-time in the next month (until end of December).

The tasks are aimed at setting up the workflow for contributing to the manual as best as possible, getting the community started and the project rolling with more visibility.

Priorities are workflow, versioning, organization, momentum and a non-unfinished look (currently there are Fixme, missing images, broken links and pages in need of review). The migration process is still unfinished and the management platform lacking important features. I also propose to review some of the generic sections that are unlikely to have interest, yielding a more polished look.

Coordinating

• Polish instructions and workflow
• Review patches
• Setup owners for each section

Migration

• Review all ToCs and Structure
• Fix cleanup ToDos
• Fix warnings
• Migrate all new changes in the wiki since August

• Theme for documentation (customize with Blender colors and logo)

Setup Workflow

• Manual versioning (following Blender's versions and current development)
• Image library, versioning and best practices
• Workflow for translations

Manual

Review/Maintain/Fix/Overhaul the generic and introductory sections, including structure-wise, keeping a philosophy of "if it ain't broken, don't fix it". There are some common problems, such as references to the "new" 2.5 series and non distinguishing between saving preferences and default scene.

• Installing Blender - This section is way too big and overly verbose, mixing in configuration as well. It could do with a rewrite for 1/3 or 1/4 the size
• Introduction - Needs review and could also benefit with a better integration with the releases' feature lists and other sections of blender.org website, removing the 'What's new in Blender 2.5'
• Preferences - Review everything, there are at least some TODO and outdated parts
• Interface - Review, there are missing images and outdated parts
• Vitals - Review, there are TODOs with missing parts
• Data System - Review, has broken links and structure
• Extensions - Review and link with individual addons documentation

Management Platform

http://www.blender.org/documentation

• Section owners and contributors
• Connection with phabricator tasks
• Status for each section
• User Feedback on the quality and usefulness of each section
• Gather statistics (number of files, page views, activity)
• Image, Blend files and external links management