Added by Andries Seutens, last edited by Andries Seutens on Nov 20, 2006  (view change)

Labels

 
(None)

About

  • What is Zend Framework?
  • Is Zend Framework right for me?
  • Roadmap
  • Core contributors
  • Copyright and licensing

Documentation

  • Zend Framework

    • Installation
    • Requirements
    • Configuration

  • Reference Manual

    • [Incubator documenation]
    • [Brazilian Portuguese]
    • [Dutch]
    • [English]
    • [French]
    • [German]
    • [Japanese]
    • [Polish]
    • [Russian]
    • [Simplfied Chinese]
    • [Spanish]
  • API Documentation (core)
  • API Documentation (incubator)

  • External Documentation

    • Tutorials
    • Articles

  • Developer Documentation

    • Standards
    • Best practice+

Miscellaneous

  • Developer Notes
  • Infrastructure
  • Community Sandbox Server
  • Requirements

Contributing

  • How can I contribute?
  • Mailing lists
  • The proposal process
  • The contributor license agreement
  • Coding standards
  • Subversion code repository
  • Issue tracker
  • Changeset browser

  • Code Contributor Guide

    • Branching Model
    • Issue Tracker Etiquette
    • PHP Coding Standard (draft, ZF 0.2 RC1)
    • RSS Feeds and Notifications
    • Subversion Standards
    • Testing Standards
    • Proposal Process

  • Documentation Guide

    • Documentation Standard
    • DocBook and Right to Left Languages
    • Getting Started
    • Manual Compilation Instructions

Project Teams

  • [Auth Team]
  • [Core Infrastructure Team]
  • [DB Team]
  • Documentation Team
  • [i18n Locale Team]
  • [MFS Team (Mail, Formats, Search)]
  • [MVC Team]
  • [Server Management Team]
  • [Web Services Team]

Comments  (Hide Comments)

There needs to be some standardization of the name of the manual. The navigation and URL say "manual," but the manual itself is titled "Programmer's Reference Guide." On the side menu it says "Zend Framework components" and also has links to the API documentation.

I propose that the name is changed to "User manual" in all locations (except the navigation and URL, which should remain "manual").

It could be composed of many of the items under "End-user documentation," structured as follows:

Zend Framework user manual

1.0 Introduction
    1.1 System requirements
    1.2 Installation and configuration
    1.3 Best practices
    1.4 Tutorials
2.0 Core components
    2.1 Zend
    2.2 Zend_Cache
    2.3 Etc.
3.0 Other resources
    3.1 API documentation (core)
    3.2 API documentation (incubator)
    3.3 ?
A.  A.1 Copyright
    A.2 License

The introduction would include copyright information. I think the coding standards should be moved somewhere else, perhaps a separate contributor guide. The information on the proposal process, license agreement, Subversion repository, etc. is important and should be translated as well.

Posted by Matthew Ratzloff at Sep 20, 2006 17:39

Currently, the Zend team uses the name "Zend Framework Reference Manual" to refer to the documentation contained in the DocBook XML files in SVN. The current wiki page above reflects substantial edits and improvements.

Posted by Gavin at Nov 20, 2006 15:16