Group items tagged

Filter: All | Bookmarks | Topics Simple Middle

On Plone documentation - Martin Aspeli - 1 views

martinaspeli.net/...on-plone-documentation

2008 2008-11 2008-11-23 Plone (software)

shared by Graham Perrin on 01 Apr 10 - Cached

I think it's a mistake to try and solve all the problems with "Plone documentation" in the same way
- Graham Perrin on 01 Apr 10
  
  +1
  
  <div class="cArrow"> </div><div class="cContentInner">+1</div>
  
  ...
  
  Cancel
...

Cancel
rely more on technology
...

Cancel
What is current good practice?
- Graham Perrin on 01 Apr 10
  
  My initial reaction to this: get started | essential actions | refinements and current best practice …
  
  <div class="cArrow"> </div><div class="cContentInner">My initial reaction to this: get started | essential actions | refinements and current best practice …</div>
  
  ...
  
  Cancel
...

Cancel
...20 more annotations...
a corpus small enough that it can be effectively reviewed
- Graham Perrin on 01 Apr 10
  
  http://dev.plone.org/plone/ticket/8746
  
  <div class="cArrow"> </div><div class="cContentInner"><a href="http://dev.plone.org/plone/ticket/8746" rel="nofollow" target="_blank">http://dev.plone.org/plone/ticket/8746</a></div>
  
  ...
  
  Cancel
...

Cancel
highlighted and easy to find
...

Cancel
this is where they should be stumbling
- Graham Perrin on 01 Apr 10
  
  Can we elaborate on this point?
  
  <div class="cArrow"> </div><div class="cContentInner">Can we elaborate on this point?</div>
  
  ...
  
  Cancel
...

Cancel
Barriers to entry should be low
...

Cancel
version the document pertains to
- Graham Perrin on 01 Apr 10
  
  +1
  
  <div class="cArrow"> </div><div class="cContentInner">+1</div>
  
  ...
  
  Cancel
- Graham Perrin on 01 Apr 10
  
  Re http://dev.plone.org/plone/ticket/7831 some simple triggers might draw attention to documentation that becomes outdated (or at least deserves review) at product update time.
  
  <div class="cArrow"> </div><div class="cContentInner">Re <a href="http://dev.plone.org/plone/ticket/7831" rel="nofollow" target="_blank">http://dev.plone.org/plone/ticket/7831</a> some simple triggers might draw attention to documentation that becomes outdated (or at least deserves review) at product update time.</div>
  
  ...
  
  Cancel
...

Cancel
concerned about how easy it is to add an article
...

Cancel
highlight the "good" bits of documentation
...

Cancel
reviewed at least each time we make a new Plone release
...

Cancel
What's the right way to configure caching?
- Graham Perrin on 01 Apr 10
  
  Advice may be diverse.
  
  <div class="cArrow"> </div><div class="cContentInner">Advice may be diverse.</div>
  
  ...
  
  Cancel
...

Cancel
If someone wants to contribute documentation, by all means let them!
...

Cancel
allow comments
...

Cancel
ratings of the type "was this helpful to you"
- Graham Perrin on 01 Apr 10
  
  I do often rate things (positively more often than negatively). However: I rarely observe other people's ratings.
  
  <div class="cArrow"> </div><div class="cContentInner">I do often rate things (positively more often than negatively). However: I rarely observe other people's ratings.</div>
  
  ...
  
  Cancel
...

Cancel
Open the flood-gates
...

Cancel
group documentation by audience, rather than by type
- Graham Perrin on 01 Apr 10
  
  I'm never wholly convinced about audience-based documentation.
  
  <div class="cArrow"> </div><div class="cContentInner">I'm never wholly convinced about audience-based documentation.</div>
  
  ...
  
  Cancel
- Graham Perrin on 01 Apr 10
  
  Can we group documentation by layer - through the Plone (TTP), Zope management interface (ZMI), file system et cetera?
  
  <div class="cArrow"> </div><div class="cContentInner">Can we group documentation by layer - through the Plone (TTP), Zope management interface (ZMI), file system et cetera?</div>
  
  ...
  
  Cancel
...

Cancel
Accept that how-to documentation won't be perfect
...

Cancel
Add ratings
...

Cancel
improve commenting
...

Cancel
this is out of date
- Graham Perrin on 01 Apr 10
  
  Maybe "This is valid for version n.n of product x" plus "For more recent advice please visit …".
  
  <div class="cArrow"> </div><div class="cContentInner">Maybe "This is valid for version n.n of product x" plus "For more recent advice please visit …".</div>
  
  ...
  
  Cancel
...

Cancel
We should allow people to make requests for new documentation, and expose the wish list in a way that lets people vote for their favourite requests
- Graham Perrin on 01 Apr 10
  
  First improvements to a document might be: (1) a link to Trac, so that any documentation-related issue can be tracked; and (2) an in-document summary of relative tickets.
  
  <div class="cArrow"> </div><div class="cContentInner">First improvements to a document might be: (1) a link to Trac, so that any documentation-related issue can be tracked; and (2) an in-document summary of relative tickets.</div>
  
  ...
  
  Cancel
...

Cancel
We have a Trac
...

Cancel

Plone 3.1.1 released! - Plone CMS: Open Source Content Management - 0 views

plone.org/...plone-3.1.1-released

Plone support upgrade advice p2664667

shared by Graham Perrin on 21 Apr 09 - Cached

If you're running older Plone 2.x sites and are unable to upgrade — make sure to follow some simple rules
...

Cancel

Of babies and bathwater (or: Why I love the Zope Component Architecture) - Martin Aspeli - 0 views

www.martinaspeli.net/...he-zope-component-architecture

2009 2009-12 2009-12-03 Python (programming language) Plone (software) Zope

shared by Graham Perrin on 03 Dec 09 - Cached

Of babies and bathwater (or: Why I love the Zope Component Architecture)
...

Cancel
Martin Aspeli
...

Cancel
Dec 01, 2009
...

Cancel
...17 more annotations...
In defence of one of the great Python frameworks of the past decade
...

Cancel
ZCA rocks. It's an incredibly advanced and powerful way to build software
...

Cancel
ZCA adds complexity. It demands that you swallow its core concepts up front (interfaces, adapters, utilities, events) and get to know them pretty well
...

Cancel
people can do crazy things, usually doing as much harm as good
...

Cancel
elegant frameworks like BFG or Pylons
...

Cancel
That doesn't mean the ZCA is right for all situations
...

Cancel
learning to use the ZCA effectively is a bit like learning a new programming language on top of Python. You need to "get" those concepts
...

Cancel
For the ZCA itself, there is clearly an opportunity right now to evolve
...

Cancel
My personal wish-list
...

Cancel
advice for projects, such as Plone, that use the ZCA for extensibility and inversion-of-control
...

Cancel
Don't let the ZCA be the first API that people see
...

Cancel
don't assume everyone has yet reached ZCA mastery
...

Cancel
ZCA as a building block
...

Cancel
BFG does this very well
- Graham Perrin on 03 Dec 09
  
  http://bfg.repoze.org/
  
  <div class="cArrow"> </div><div class="cContentInner"><a href="http://bfg.repoze.org/" rel="nofollow" target="_blank">http://bfg.repoze.org/</a></div>
  
  ...
  
  Cancel
...

Cancel
We're trying to do something similar with Dexterity and the ecosystem of tools around it
...

Cancel
The same will hopefully be true for other technologies as we move towards Plone 5
...

Cancel
improved integrator learning curve
...

Cancel

Graham Perrin on 03 Dec 09

referred from http://twitter.com/optilude/status/6238077813

<div class="cArrow"> </div><div class="cContentInner">referred from <a href="http://twitter.com/optilude/status/6238077813" rel="nofollow" target="_blank">http://twitter.com/optilude/status/6238077813</a></div>

...

Cancel

1 - 3 of 3

Showing 20▼ items per page

Group items tagged

On Plone documentation - Martin Aspeli - 1 views

Plone 3.1.1 released! - Plone CMS: Open Source Content Management - 0 views

Of babies and bathwater (or: Why I love the Zope Component Architecture) - Martin Aspeli - 0 views

Related searches