[DOCU-321] Analyse all Docu for Tips, Recommendations, Best Practises and similar Created: 17/Sep/12  Updated: 03/Nov/15

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Gavan Stockdale Assignee: Gavan Stockdale
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   
  • Using Docu search analyze all Official Docu for Tips, Recommendations, Best Practises and similar.
  • Make a list of all pages where these items appear. For Tips. Distinguish between Tips that just provide extra, nice to know, information and tips that provide distinct advice.
  • Identify sections and pages where a Best Practice macro could be inserted.
  • Identify categories of information that have tips, Best Practises etc.
  • Add collected pages to http://wiki.magnolia-cms.com/display/DOCS/Going+Forward+-+Best+Practices


 Comments   
Comment by Gavan Stockdale [ 19/Sep/12 ]

See: http://wiki.magnolia-cms.com/display/DOCS/Best+Practices

Also: http://wiki.magnolia-cms.com/display/TALKOOT/2012/09/18/Conference+Feedback+-+Best+Practices

And: http://docuauthor.magnolia-cms.com/reference/best-practices.html

Don't think it would be too big a task to insert an

{inf0: Best Practice}

macro to each page, where relevant. There are 85 or so. Could do 3-5 in an hour if text doesn't require lots of editing as a result.

Might be good to specify in Style guide when to use Tip and when to provide a Best Practice. For example, A Tip could be a bit of advice about where to store files. While a Best Practice would be a recommendation about using DMS to store website assets.

Generated at Mon Feb 12 01:08:01 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.