JDOC

Difference between revisions of "Docs Wiki Roadmap"

From Joomla! Documentation

m (→‎Short Term: some changes)
m (→‎Short Term: update to roadmap)
(24 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{notice|Under construction, will eventually be moved to [[JDOC:Documentation Wiki Roadmap]]. Please post all comments to the [[User_talk:Hutchy68/Docs Wiki Roadmap|Hutchy68/Docs Wiki Roadmap]] talk page. Please feel free to add appropriate items to the Roadmap.}}
+
{{shortcut|JDOC:DWR|JDOC:MAP}}{{notice|Please add appropriate items to the Roadmap and post all comments to the [[JDOC_talk:Docs Wiki Roadmap|Docs Wiki Roadmap]] talk page.}}
 
{{RightTOC}}
 
{{RightTOC}}
−
This might need to be wider in scope for Documentation.
 
  
 
==Docs Wiki Roadmap==
 
==Docs Wiki Roadmap==
Line 8: Line 7:
 
*Identify documentation needs by user type better
 
*Identify documentation needs by user type better
 
:*Beginners - need to be more targeted
 
:*Beginners - need to be more targeted
 +
::*Easy Tutuorials - short and concise (using as a model - Wikipedia's [[wikipedia:Wikipedia:Tutorial|Wikipedia:Tutorial]])
 +
::*Beginners need targeted core ideas and methods (Too much information puts off)
 +
::*Easy to navigate and follow
 +
::*<strike>Use of [[mw:Extension:Header_Tabs|Header Tabs extension]]</strike>
 +
:::'''Installed!''' see example of use [[User:Hutchy68/Getting Started test page|Hutchy68/Getting Started test page]] or [[Installing Joomla!]]
 
:*Developers - more involvement, better method of involvement
 
:*Developers - more involvement, better method of involvement
 +
::*Projects - [[JDOC:Developer Tutorials Project]],
 +
::*Better Event integration such as Pizza, Bugs and Fun. Doc's home page integration, upcoming events template.
 
:*Web designers - target ease of design, better articles targeted towards CSS, Bootstrap
 
:*Web designers - target ease of design, better articles targeted towards CSS, Bootstrap
 +
::*Projects - need ideas
 
:*Administrators - target common tasks with more detail
 
:*Administrators - target common tasks with more detail
 
:*Evaluators - ideas needed?
 
:*Evaluators - ideas needed?
−
*Home page
+
* <strike>Recognition of contributions, work on wiki</strike> complete, see [[Template:Barnstar|Barnstar awards]]
 +
*Home page - start of redesign is [[User:Hutchy68/New main page|here]]
 
*Navigation
 
*Navigation
−
**Portal pages
+
:*Portal pages
−
**Better documentation search
+
:*<strike>Better documentation search - Google integration? Lucerne?</strike>
−
**Improve structure
+
::'''Installed!''' Google CSE, [[Special:GoogleCustomWikiSearch|GoogleCustomWikiSearch]] - testing currently
−
**Namespace aliases for easier link building
+
:*Improve structure
−
*Spam control
+
:*Namespace aliases for easier link building
 +
::'''Help screen aliasing''' - All Joomla! 3.x series Help screens will alias to one set of Help screens
 +
:*Disambiguation pages
 +
*<strike>'''Spam control''' - multipage sign up. AntiSpoof, AbuseFilter together.</strike>
 +
:*<strike>AbuseFilter (Tested! - see [[JDOC_talk:Docs Wiki Roadmap|Talk page]]) -  will automatically block and remove users based on rules, can be new user time sensitive running against only new users.</strike>
 +
::'''Installed!''' and working now, see [[Special:AbuseLog|AbuseLog]] and [[Special:AbuseFilter|AbuseFilter]]
 
*Clean up redundant and incomplete pages (what was started and never finished, or redundant)
 
*Clean up redundant and incomplete pages (what was started and never finished, or redundant)
 +
:*Investigate 'Archive' namespace, would want an alias of 'A' to simplify link creation when needed
  
 
===Long Term===
 
===Long Term===
−
*Increase developer contributions
+
*Increase developer contributions!
−
**Welcome new users on user talk pages
+
:*Welcome new users on user talk pages! Give them some additional information, style guide, templates available, etc.
−
**Editor assistance
+
:*Editor assistance
−
***Adopt an editor?
+
:**Adopt an editor? Help new wiki users
−
**Wiki Doc Projects
+
:*Wiki Doc Projects - "JDOC Projects" - Portal page:[[Portal:JDOC Projects|JDOC Projects]]
−
**Developer feedback
+
::*Developers
−
**Enhance styleguide
+
::*Designers
 +
::*Better tutorials, multipage, PDF's created for download
 +
:*Developer feedback
 +
:*Enhance styleguide
 
*API integration with Platform and CMS
 
*API integration with Platform and CMS
 
*Help Screen development simplify
 
*Help Screen development simplify
−
**Focus on first STS, ported to subsequent STS versions, with a 'Final' for LTS
+
**Focus on first STS, transcluded to subsequent STS versions, with a 'Final' for LTS
 +
**Notices on support ended versions
 +
**Better understanding for contributors, Help screens: how they work, why style guides are important
  
 
===Nice to have eventually===
 
===Nice to have eventually===
Line 39: Line 58:
 
**Improved look
 
**Improved look
 
**Integration with administration for VEL notifications of installed Extensions.
 
**Integration with administration for VEL notifications of installed Extensions.
−
 
+
* Multilingual support
 
==Investigation==
 
==Investigation==
 
*Semantic Mediawiki  
 
*Semantic Mediawiki  
 
**Use of property values within articles/API
 
**Use of property values within articles/API
 
**External data capture in XML or JSON (other formats also available)
 
**External data capture in XML or JSON (other formats also available)
 +
<noinclude>[[Category:Documentation Wiki Information|{{PAGENAME}}]]

Revision as of 20:04, 11 March 2013

Shortcuts:
JDOC:DWR
JDOC:MAP
Info non-talk.png
General Information

Please add appropriate items to the Roadmap and post all comments to the Docs Wiki Roadmap talk page.

Docs Wiki Roadmap[edit]

Short Term[edit]

  • Identify documentation needs by user type better
  • Beginners - need to be more targeted
  • Easy Tutuorials - short and concise (using as a model - Wikipedia's Wikipedia:Tutorial)
  • Beginners need targeted core ideas and methods (Too much information puts off)
  • Easy to navigate and follow
  • Use of Header Tabs extension
Installed! see example of use Hutchy68/Getting Started test page or Installing Joomla!
  • Developers - more involvement, better method of involvement
  • Web designers - target ease of design, better articles targeted towards CSS, Bootstrap
  • Projects - need ideas
  • Administrators - target common tasks with more detail
  • Evaluators - ideas needed?
  • Recognition of contributions, work on wiki complete, see Barnstar awards
  • Home page - start of redesign is here
  • Navigation
  • Portal pages
  • Better documentation search - Google integration? Lucerne?
Installed! Google CSE, GoogleCustomWikiSearch - testing currently
  • Improve structure
  • Namespace aliases for easier link building
Help screen aliasing - All Joomla! 3.x series Help screens will alias to one set of Help screens
  • Disambiguation pages
  • Spam control - multipage sign up. AntiSpoof, AbuseFilter together.
  • AbuseFilter (Tested! - see Talk page) - will automatically block and remove users based on rules, can be new user time sensitive running against only new users.
Installed! and working now, see AbuseLog and AbuseFilter
  • Clean up redundant and incomplete pages (what was started and never finished, or redundant)
  • Investigate 'Archive' namespace, would want an alias of 'A' to simplify link creation when needed

Long Term[edit]

  • Increase developer contributions!
  • Welcome new users on user talk pages! Give them some additional information, style guide, templates available, etc.
  • Editor assistance
    • Adopt an editor? Help new wiki users
  • Wiki Doc Projects - "JDOC Projects" - Portal page:JDOC Projects
  • Developers
  • Designers
  • Better tutorials, multipage, PDF's created for download
  • Developer feedback
  • Enhance styleguide
  • API integration with Platform and CMS
  • Help Screen development simplify
    • Focus on first STS, transcluded to subsequent STS versions, with a 'Final' for LTS
    • Notices on support ended versions
    • Better understanding for contributors, Help screens: how they work, why style guides are important

Nice to have eventually[edit]

  • VEL page
    • Improvement for editing by approved VEL members
    • Searching
    • Improved look
    • Integration with administration for VEL notifications of installed Extensions.
  • Multilingual support

Investigation[edit]

  • Semantic Mediawiki
    • Use of property values within articles/API
    • External data capture in XML or JSON (other formats also available)
Retrieved from "https://docs.joomla.org/index.php?title=JDOC:Docs_Wiki_Roadmap&oldid=82486"