[DOCU-165] Write better module descriptions for Magnolia Store Created: 27/Jun/11  Updated: 03/Nov/15

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

Type: Task Priority: Neutral
Reporter: Antti Hietala Assignee: Antti Hietala
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: Microsoft Word MagnoliaStore-summary.docx    
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 Description   

Go through the module list in Magnolia Store and verify that each module has a description.

Guideline:

  • Description should be a concise, interest-triggering summary of the module's purpose and features.
  • Aim for 25 words for the short description on the module list. Good example: Content Translation Support. Don't repeat the module name, it's already on the list.
  • Aim for 100-150 words for the long description on the module page. Good example: Content Dependencies.
  • If no module description can be found or the existing description is too short or badly written, write a new one. Use the material in the module article to summarize the module's capabilities.
  • Add a bulleted lists of features if it works better than a narrative paragraph.
  • If a screenshot helps a reviewer understand the module, attach a screenshot.
  • Verify that the module page has a More Info link that points to an article on documentation site. Make a list of modules that are missing such link, for example Imaging.
  • If a module is listed on the Store but no article exists on documentation site, make a list non-documented modules in this ticket.


 Comments   
Comment by Antti Hietala [ 27/Jun/11 ]

Assigning to Ruth for first pass. To do: Find out where to edit the descriptions.

Comment by Ruth Stocks [ 02/Aug/11 ]

Draft content in attached file - MagnoliaStore-summary.docx

Comment by Ruth Stocks [ 02/Aug/11 ]

Summary of draft content for Magnolia store page and individual module download pages.

Comment by Antti Hietala [ 21/Oct/11 ]

Updated module store with new descriptions and screenshots.

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