Documentation Planning

lsmith77 edited this page Dec 1, 2012 · 20 revisions
Clone this wiki locally

All documentation is managed in the repository https://github.com/symfony-cmf/symfony-cmf-docs

Compiled doc is online at http://symfony.com/doc/master/cmf/index.html

Format and guidelines

  • We use restructuredText and follow symfony doc standards: http://symfony.com/doc/2.0/contributing/documentation/format.html
  • Always remember users may want to combine the cmf bundles, but not necessarily.
  • We already have some fragmentation of the docs and in the respective README files. Try to extract the docs from there and improve them - and please send pull requests to remove documentation that was moved here. We do not want too much duplication!
  • Keep the targeted audience in mind

Audience

Developer with no knowledge of CMF

  • Wants to know if the CMF fits his project
  • Pros and cons
  • Key concepts
  • Birds-eye view of the project and components
  • Installation guide

Developer with some knowledge of CMF

  • Birds-eye view of the project and components
  • Overview of the different components
  • Practical/implementation examples
  • Installation guide

Developer with a lot of knowledge of CMF

  • Practical/implementation examples
  • References for configuration etc

Developer who wants to use a specific bundle independently

  • Installation guide of a specific bundle
  • Practical/implementation examples
  • References for configuration etc