SoftwareDocumentationStandard-template.json

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "../Documentation/Implementation/data_model/Json/",
    "title": "SoftwareDocumentationStandard",
    "description": "SoftwareDocumentationStandard template",
    "dataTypes": [
        "software"
    ],
    "type": "object",
    "class": "SoftwareDocumentationStandard",
    "properties": {
        "documentationReference": {
            "type": "array",
            "table_header": null,
            "items": {
                "type": "object",
                "class": "ResourceReferenceStandard",
                "properties": {
                    "dbid": {
                        "type": "number"
                    }
                },
                "template_name": "SoftwareResourceReference",
                "required": [
                    "dbid"
                ]
            },
            "description": "Document reference",
            "label@fr_FR": "Références associées",
            "label@en_GB": "Linked references",
            "tooltip@fr_FR": "Penser à rédiger au minimum un fichier README avec les éléments permettant l’installation du code (dépendances, …) et la façon de l’utiliser. Idéalement, intégrer des exemples d’utilisation. Et si l’objectif est d’avoir des contributions externes, il est nécessaire de prévoir une documentation développeur.",
            "tooltip@en_GB": "At least, write a README file with all the elements required to install the code (dependencies, etc.) and how to use it. Ideally, include examples of how to use it.  And if you're looking for external contributions, you'll need to include developer documentation.",
            "form_label@fr_FR": "Indiquer les liens vers la documentation utilisateur et/ou développeur si elle est disponible",
            "form_label@en_GB": "Provide links to user and/or developer documentation, if possible"
        },
        "description": {
            "type": "string",
            "description": "Additional information conerning the documentation produced",
            "inputType": "textarea",
            "label@fr_FR": "Informations complémentaires",
            "label@en_GB": "Additional information",
            "tooltip": null,
            "example@fr_FR": "Vous pouvez ici compléter la description des méthodes et/ou outils adoptés pour documenter le code et l'utilisation du logiciel.",
            "example@en_GB": "Include here descriptions of the methods or tools used to document the code and se of the software.",
            "form_label@fr_FR": "Informations complémentaires",
            "form_label@en_GB": "Additional information"
        }
    },
    "required": [
        "description"
    ],
    "to_string": []
}