Idées de projets

Phase actuelle:
Le programme Season of Docs 2019 s'est terminé le 6 mars 2020. Consultez la chronologie.

Les idées de projet sont des suggestions d'une organisation Open Source pour des projets qu'un rédacteur technique peut réaliser en collaboration avec un mentor pendant Season of Docs.

Les informations de cette page sont destinées aux administrateurs et aux mentors d'organisations Open Source qui préparent leur liste d'idées de projets. Ces informations sont également utiles pour les rédacteurs techniques dans le contexte de la participation des organisations à Season of Docs.

Exemples de projets

Voici quelques idées de projets auxquels un rédacteur technique peut s'occuper:

  • Créer un site de documentation sur une plate-forme qui sera choisie par le rédacteur technique et le mentor Open Source, et publier un ensemble initial de documents de base sur le site. Voici quelques exemples de plates-formes:

  • Refactorisez la documentation existante du projet Open Source pour offrir une expérience utilisateur améliorée ou une architecture des informations plus accessible.

  • Rédiger une présentation conceptuelle d'un produit ou d'une fonctionnalité, ou en présenter un. Souvent, une équipe crée sa documentation technique de bas en haut, ce qui signifie qu'il y a beaucoup de détails, mais qu'il est difficile de comprendre le produit dans son ensemble. Un rédacteur technique peut résoudre ce problème.

  • Créez un tutoriel pour un cas d'utilisation important.

  • Créez un ensemble de guides d'utilisation dédiés à des tâches spécifiques.

  • Créez un guide du contributeur contenant des informations de base sur les premiers pas en tant que contributeur du projet Open Source, ainsi que les règles concernant les contrats de licence, les processus de demande d'extraction et de révision, la création du projet, etc.

La portée et la taille des idées ci-dessus varient intentionnellement. La durée d'un projet dépend d'un certain nombre de facteurs, y compris la taille de la documentation, la complexité du produit, l'expérience du rédacteur technique et des mentors Open Source, les outils et les processus proposés par le projet Open Source, etc.

Le but de la liste ci-dessus est de vous aider à démarrer. Vous pouvez également proposer d’autres types de projets.

Publier votre liste d'idées de projets

Vous devez publier vos idées de projet sur une page Web publique, dans un article de blog ou dans tout autre document visible publiquement.

Votre page d'idées de projet doit inclure:

  • Informations sur votre organisation Open Source:

    • Nom de l'organisation.
    • Description de l'organisation.
    • Un lien vers votre dépôt et/ou votre site Web Open Source
    • (Facultatif) Adresse e-mail pour contacter votre organisation à propos de Season of Docs. Elle doit être identique à l'adresse e-mail que vous avez indiquée dans le formulaire de demande de votre organisation pour Season of Docs.
    • (Facultatif) Informations sur l'administration et les mentors de votre organisation, telles que leur nom à afficher. Ils doivent être identiques aux noms à afficher que vous incluez dans le formulaire de demande de votre organisation pour Season of Docs.

  • Une annonce indiquant que votre organisation souhaite participer à cette année, saison des documentaires. La page Promotion et presse inclut des logos et d'autres contenus que vous pouvez utiliser lorsque vous parlez de Season of Docs.

  • Votre ou vos idées de projet, y compris les informations décrites ci-dessous pour chaque idée.

Lorsque vous créez la candidature de votre organisation pour Season of Docs, vous devez inclure un lien vers la page de vos idées de projet.

Les informations dans chaque idée de projet

Chaque idée de projet doit inclure au moins les informations suivantes:

  • Nom du projet:choisissez un titre concis, mais descriptif.
  • Description:description plus longue du travail de documentation requis. Décrivez en détail votre idée initiale. Offrez la possibilité aux rédacteurs techniques intéressés de développer ou d'affiner l'idée.

  • Ressources associées:

    • Lien vers le projet Open Source qui a besoin de documentation.
    • Si vous proposez un projet d'écriture technique impliquant des mises à jour d'un ensemble de documentation existant, créez un lien vers cet ensemble de documentations.
    • Si vous proposez un tutoriel ou un ensemble de guides d'utilisation, décrivez les fonctionnalités ou les cas d'utilisation qui doivent être documentés.
    • Si vous proposez un guide destiné aux contributeurs, créez un lien vers un fichier README existant ou vers tout autre document pertinent, le cas échéant. Si rien n'est encore disponible, il est possible de le dire.
    • Incluez des liens vers des documents similaires dans d’autres projets, le cas échéant.

Importance des idées du projet

Les idées de votre projet sont importantes à plusieurs égards:

  • Travailler sur les idées aide votre organisation à formuler les tâches de documentation requises et à se préparer à travailler avec un rédacteur technique.
  • Les idées de projet donnent aux administrateurs de programme Google une indication du type de travail auquel un rédacteur technique doit s'occuper lorsqu'il entreprend une relation de mentorat avec votre organisation. Les administrateurs du programme Google utilisent les idées de projet pour évaluer l'engagement de l'organisation à participer à Season of Docs et à encadrer un rédacteur technique tout au long du programme.
  • Les idées de projet attirent les rédacteurs techniques intéressés vers votre organisation. Ils peuvent utiliser vos projets suggérés comme base pour leurs propres propositions de projet.
  • La page Promotion et presse inclut des logos et d'autres contenus que vous pouvez utiliser lorsque vous parlez de Season of Docs.
  • Cette vidéo de PyCon Australia 2017 donne des conseils sur l'organisation de votre documentation de manière à ce que les utilisateurs la trouvent utile : Ce que personne ne vous dit sur la documentation de Daniele Procida.