OK, now that I have this SDT model, what can I do with it ?
❓Our interactions with SDT users have highlighted some recurring queries:
– What are the data structures used in SDT? (models, deformations, transfers…)
– What can I do with each one of them? (examples, tutorials, list of functions, …)
– I want to call a specific function/command but what are the required inputs? Which format? Options? Examples?
💡Answering these questions clearly relates to how information can be efficiently retrieved from documentation
❗To tackle this issue, SDTools recently launched an internal process of indexing source code, documentation, and support materials in general with tags. The objective is to build a database linking information about data structure (documentation page, format, examples, …) and function/commands (documentation, syntax, inputs, outputs, options, …). That way keywords or tags can be efficiently searched in the whole SDT and directly provide contextual links of any type.
💭The following scenario shows how we could navigate in such a database (it corresponds to the above illustration)
☝️ I want to perform MDRE expansion
👉 A1 – Let’s have a look at the command documentation page
👉 A2 – I need model as first input but what is the SDT model format again? Can I have an example?
☝️ I have a SDT model
👉 B1 – Let’s have a look at the SDT structure documentation page
👉 B2 – What can I do with this model? For instance, MDRE expansion, but this will require additional structures Sens, tdef and RO… do I have them?
⚙️This is also an opportunity to rethink the way documentation is built, through a more automated process to improve consistency and ease maintenance.
🕒Let’s see in a few months (years? 😅) where this goes, but we are motivated!