Skip to main content
QuintinSeegers
Legend
July 12, 2021
Answered

Next step up from using EDD (FM2019)

  • July 12, 2021
  • 1 reply
  • 1209 views

We've successfully moved from unstructured to structured FrameMaker, creating an extensive EDD to cater for the different elements (type of content) our documents contain. This is working very well for us. Now we want to move to the next step - using DITA.

 

Just like starting out with Structured FM, I'm at a complete loss where to begin.I've watched a number of YT videos on the topic, but most seems to go with the assumption that you're already familiar with DITA. I need something that goes back to real basics.

 

Can anyone point me in the right direction?

Thanks,

Quintin

 

    This topic has been closed for replies.
    Correct answer QuintinSeegers

    This is what the @audience attribute is for in DITA:

     

    <p audience="enduser">Enjoy this training course. After going through it you will be a rock star.</p>
    <p audience="admin">This certified training course is for IT-Professionals only.</p>

     

    You just apply your self-definied attribute values. For HTML5 output you define the values and then users of the output can "filter" the content on their own with checkboxes, or you create multiple outputs. As uch filtering is not there in PDF, for PDF you would just create multiple PDFs.

    Personally, I prefer this way of attribute-based filtering over conditional text in XML projects.


    Thank you everyone for your input on this question. Much appreciated.

     

    Having looked at the the Elements available in just a DITA topic, none of our content writers/consultants won't have a clue what elements to use. They will find it endlessly frustrating and just end up creating documents in MS Word because it's easier. It also doesn't enforce the restrictions we have in our Corporate Style Guide, e.g. bulleted and numbered lists cannot be more than 3 levels deep; no more than 6 heading levels are allowed under a topic.

     

    In contrast, our custom EDD has elements that our content writers/consultants can relate to, e.g. Heading, Paragraph, BulletList, NumberedList, Screenshot, InlineImage, Notes, FieldList, etc.

     

    I can see the benefit of going with DITA if you don't have any sort of document structure in placed, or if you're in an industry where there is an established structure that you have to adhere to. Neither is the case in our organisation. We're also fortunate that our Style Guide for training documentation is very clear on the formatting/layout of said documentation. The comment raised by @Stefan Gentz about wanting additional elements or using elements in an unsupported context just aren't ones entertained. The structure is defined for a reason  - revise the context in which you want to add the content to conform to the structure.

     

    I'm in favour of using establishes standards, provided they are appropriate. In our case, DITA as a standard won't work for our organisation. As @frameexpert mentioned, creating a custom Structured Application might we the better solution for us.

     

    Thanks,

    Quintin

     

    1 reply

    frameexpert
    Community Expert
    Community Expert
    July 12, 2021

    DITA is designed for topic-based authoring, so I usually suggest that my clients get a book that describes the DITA DTD/schema so they can see if their documentation can be made to fit into the DITA structure. Or you can watch videos or take a course that describes DITA and its elements and attributes. If you determine that DITA is right for you, then it is a matter of customizing the FrameMaker DITA templates to match your desired look and feel.

    www.frameexpert.com
    QuintinSeegers
    Legend
    July 12, 2021

    "DITA is designed for topic-based authoring". How is this different from a FM Book made up of various documents, each being a separate topic of content?

    QuintinSeegers
    Legend
    July 14, 2021

    That's the trouble with producing a content model from scratch...there's a lot to do, even if you don't change directions in the middle of the project. That's why you'll see so much discussion of DITA, S1000D, and aerospace/defense standards. When the content model is already created and supported (by Fm in this case) you can start with content and reuse more easily, even if the content model isn't 100% what you'd have wanted or chosen.


    I was hoping the existing standards supported by FM would work for us as is, but doesn't look like it will.

    I've already spent a fair amount of time creating an EDD for our collateral and a conversion table to convert our existing unstructured documents to structured FM. I'm happy to invest the time and effort into creating a 'standard', provided it works for us. We may end up with some sort of 'hybrid' module.

    Thanks,

    Quintin