home contents changes options help subscribe edit (external edit)

last edited 2 years ago by simon

DocumentationOrganization Proposal

check out the DocumentationOrganizationDiscussion

  • Contact

  • Community contribution

    • Maik Roeder, Tom Deprez, Rik Hoekstra

  • Worksheet

  • Problem

    • People kept asking Karl Anderson from Digital Creations where the Book draft is, and the only way to find it was in a news item or directly in Michel's member page

      • Paul Everitt finally added Zope Book prominently on the Zope home page

    • There are a ton of really good resources and documents that aren't getting visibility.

  • Risk Factors

  • Scope

    • This project explicitly does not include the creation of new tools.

  • Proposed Solution

    • Organize content by categorizing stuff in a similar style as the products have been categorized. The Howtos are currently categorized by Tim Cook.

    • Create really useful, elegant Documentation pages with

      • good HTML,
      • good organization in sections focused on audiences
      • editorial value by summarizing links before people click
      • highlight important stuff like Zope Book

    • Style guideline for presentation of the Documentation page

      • section title

      • some text

      • quick links

      • Features on both levels highlight a documentation resource or perhaps a person

        • Place to write reviews of documentation resources and

        rate them

        • help guide readers to good documentation resources
        • encourage documenters to higher standards

      • link to "More..." page under Documentation

        • comment on and summarize important documentation resources for that audience
        • longer review that reveals the pros and cons in the documentation resource being reviewed

    • Ask authors to rewrite out-of-date stuff

    • Proposal for Documentation from Paul

      • http://lists.zope.org/pipermail/zope-web/2000-September/000144.html

      • Feature

        • Ever want to get more performance out of your Zope site? In his _Zope and Squid_ How To, Itamar describes putting Squid, and http accelerator and cache server, in front of Zope. Itamar includes specific details. Three stars (out of four).
        • Security Assertion Proposal | More..

      • Content Managers

        • Zope provides a unique facility for turning control over to authors of content. These documentation resources describe Zope for content managers.
        • Zope Book | ZDP | More...

      • Developers

        • Developing for Zope etc.
        • DevShed? Article | Product Tutorial | More...

      • Administrators

        • Zope is installed and operated like other server applications, such as Apache. These documentation resources describe aspects of Zope administration.
        • ZAG | More...

      • Other Resources

        • Zope has a growing amount of documentation, but this documentation is spread across a number of sites. The items listed here are good places to look for more information on Zope.
        • ZDP | Mailing Lists | More

    • Developer Documentation comments from Paul



subject:
  ( 1 subscriber )