Pabloawiki added a comment.
comment Rédiger la documentation utilisateur et technique sur wikidata Pour rédiger la documentation utilisateur et technique sur Wikidata, il est important de cibler votre public et de répondre aux questions qu'il pourrait se poser lors de l'utilisation de votre système, logiciel ou application. Vous pouvez inclure la population, des vidéos et des tutoriels intégrés dans le logiciel pour faciliter la compréhension de l'utilisateur. La documentation technique est un document utile qui doit répondre à un besoin identifié. Pour créer un document qui ne finira pas à la poubelle, il faut choisir le type de documentation qui correspond le mieux à la cible pour laquelle vous rédigez ces lignes. Wikidata fournit des outils pour écrire en langage naturel des tests d'exigence, ce qui permet de créer des scénarios utilisateur simples et d'obtenir une documentation exécutable. Vous pouvez également générer de la documentation pour les APIs avec la solution Swagger. Il est également recommandé de penser à la documentation utilisateur très tôt dans le projet et de la lier à la réflexion sur l'ergonomie générale. Des exemples de bonnes pratiques incluent la documentation utilisateur de Dropbox et celle de SensCritique, qui sont bien structurées et faciles à naviguer comme documention d'utilisateur TASK DETAIL https://phabricator.wikimedia.org/T389599 EMAIL PREFERENCES https://phabricator.wikimedia.org/settings/panel/emailpreferences/ To: Pabloawiki Cc: Pabloawiki, MarcosAdo, KINDEHOUNME, Thalie30, Elie243, Aklapper, pywikibot-bugs-list, Paul26, mevo, Danny_Benjafield_WMDE, S8321414, Astuthiodit_1, karapayneWMDE, Invadibot, PotsdamLamb, Jyoo1011, maantietaja, JohnsonLee01, SHEKH, Dijkstra, Khutuck, Nintendofan885, Akuckartz, Zkhalido, Aram, Viztor, Nandana, Wenyi, Lahi, Gq86, GoranSMilovanovic, QZanden, Tbscho, KimKelting, MayS, LawExplorer, Mdupont, JJMC89, Dvorapa, _jensen, rosalieper, Altostratus, Avicennasis, Hannolans, Scott_WUaS, mys_721tx, Wikidata-bugs, Xqt, Hydriz, aude, jayvdb, Nemo_bis, Lydia_Pintscher, Masti, Alchimista, Mbch331
_______________________________________________ pywikibot-bugs mailing list -- [email protected] To unsubscribe send an email to [email protected]
