We launched new forums in March 2019—join us there. In a hurry for help with your website? Get Help Now!
    • 27106
    • 147 Posts
    As far as I know, there is currently no manual or guide for the people who use MODX Revolution to update and add content on existing websites.

    These people do not need to write templates or add snippets. They are not developers or designers. They just need to add text and photos and the like. Making life easy for these people is crucial for any designer or developer handing over a website to a client or to non-development staff.

    They need instructions on how to use CSS styles, why pasting straight out of MS Word is bad, how to take shortcuts by duplicating existing pages, how to publish a document, and much more.

    I'm creating a MODX Revo end-user manual for a client and will be publishing it with a Creative Commons licence. It will be all ready for anyone to paste into a Word or InDesign template and hand to a client.

    What should be in such a manual?

    Such manuals have been created for MODX Evolution and I am taking them as a starting point:

    If anyone has suggestions for content, please feel free to post them in this thread. That way, even if they don't get incorporated in my version of the manual, they will be available for others to add to their version. [ed. note: shorewalker last edited this post 11 years, 7 months ago.]
      David Walker
      Principal, Shorewalker DMS
      Phone: 03 8899 7790
      Mobile: 0407 133 020
      • 27106
      • 147 Posts
      OK, additional question while you're all digesting that one: does anyone have an example of a great end-user manual created for another CMS?
        David Walker
        Principal, Shorewalker DMS
        Phone: 03 8899 7790
        Mobile: 0407 133 020
      • This is a great idea but I think this is relative to how the developer sets up MODX for the user, for example I use Form Customization for my clients and only show them the content fields and tabs they should have access to.

        Another thing to keep in mind is not every developer installs TinyMCE (although they should IMHO) so that is another factor that could render said documentation useless, galleries and images are another thing some people use gallery add on others use MIGX, not every MODX installation is the same.

        Your idea sounds great but these are just some things you should keep in mind when making it, but having a starting point sounds like a good start so I applaud you for taking the initiative in doing this, let me know when it's done so I can post a link to it on CMSTricks.

        Good Luck.
          Benjamin Marte
          Interactive Media Developer
          Follow Me on Twitter | Visit my site | Learn MODX
          • 27106
          • 147 Posts
          The plan is to release it as a Word document which anyone can hack around to their heart's content, add their firm's logo to, etc.
            David Walker
            Principal, Shorewalker DMS
            Phone: 03 8899 7790
            Mobile: 0407 133 020
          • That sounds great here's a link to an Evo one Anne posted on twitter a while ago:

            http://www.scribd.com/doc/27587772/MODx-Editor-Guide
              Benjamin Marte
              Interactive Media Developer
              Follow Me on Twitter | Visit my site | Learn MODX
            • That's a very nice piece of documentation!
                Studying MODX in the desert - http://sottwell.com
                Tips and Tricks from the MODX Forums and Slack Channels - http://modxcookbook.com
                Join the Slack Community - http://modx.org
                • 27106
                • 147 Posts
                Just to clarify, my intent is to release the finished guide under the Creative Commons Attribution-ShareAlike 3.0 Australia License - http://creativecommons.org/licenses/by-sa/3.0/au/
                  David Walker
                  Principal, Shorewalker DMS
                  Phone: 03 8899 7790
                  Mobile: 0407 133 020
                  • 36909
                  • 15 Posts
                  Subscribing. I'm very interested in the end result. Since I manage a lot of MODX installations for my clients, I tend to set up each installation the same way, making a document like you are building ideal for me. I will play around with the link provided by benmarte for the time being...
                  • Subscribe...
                      zaenal.lokamaya
                    • I'm already thinking of need for this, so clients can have a reference help after handover. Would like to know how much progress you've made and do tell us where we all can be useful.

                      MODx is great in many ways but needs a lot of maturity, documentation a starting point.