- From: Keith Schengili-Roberts <keith.roberts@ixiasoft.com>
- Date: Wed, 12 Jul 2017 16:02:17 +0000
- To: "public-schemaorg@w3.org" <public-schemaorg@w3.org>
- Message-ID: <BY2PR05MB197519A217A634534F2783DD98AF0@BY2PR05MB1975.namprd05.prod.outlook.com>
I have been lurking and learning in this forum for some time, and I would like to propose a schema.org structure to describe technical documentation content. My background is in DITA structured content, which comes in five distinct topic types: concept, reference, task, troubleshooting and glossentry (glossary entry). These topic types and their variants are defined in the OASIS DITA specification at: http://docs.oasis-open.org/dita/dita/v1.3/os/part2-tech-content/archSpec/technicalContent/dita-technicalContent-InformationTypes.html#dita_technicalContent_InformationTypes. There is already a hierarchy in schema.org for TechArticle, which currently only contains APIReference. I suggest adding to this hierarchy new child elements that match the names of the existing DITA topic types, which would give us: - CreativeWork - Article - TechArticle - APIReference - Concept - GlossEntry - Reference - Task - Troubleshooting There is already a well-defined specification for these topic types, so it ought to be relatively straightforward to define the properties for each element in the hierarchy. And while I am coming from a DITA perspective, there is technical writers creating non-structured content could also use these elements. Am hoping for some good discussion on this. Ideally I would like to outline possible properties for each element, and then leave the tool vendors to figure out how to output the appropriate Schema.org element values. Cheers! - Keith Schengili-Roberts Market Researcher and DITA Evangelist Chair of the OASIS DITA Adoption Committee IXIASOFT 825 Querbes, Suite 200, Montréal, Québec, Canada, H2V 3X1 tel + 1 514 279-4942<tel:%2B%201%20514%20279-4942> / toll free + 1 877 279-4942<tel:%2B%201%20877%20279-4942> robertsk@ixiasoft.com<mailto:robertsk@ixiasoft.com> / www.ixiasoft.com<http://cp.mcafee.com/d/FZsS83gArhohhoh76zBN4TsSCztdBNV5xMSCztdBNVZUsrjhKCOUYyMedETo7n79EzCjpkDYqJxUa9RDVWN-SZ3oG_jBPpeI_fmfSTEr5nWsKrus7fnjovW_8TuKyqeuLsKCONvAQm4T6emKDp55mVEVvVkffGhBrwqrhdECXYDuZXTLuZPtPo0agvbqltDO-6P_QDO7GOfBk5i3VriHI-ndFEKc8L6MQ1wQg60MbwAQg1eDNd40Bm3LN-5Ld40Qp-4Ph07vfp7QdIL6Y11Q5gJZM7na>
Received on Wednesday, 12 July 2017 16:02:52 UTC