Créer une déclaration d'intérêt

Phase actuelle:
annonce des résultats dans le calendrier.

Dans le programme Season of Docs, les organisations collaborent directement avec les rédacteurs techniques pour créer, améliorer et mettre à jour la documentation. Les entreprises choisissent directement les rédacteurs techniques. Les rédacteurs techniques qui souhaitent travailler avec des organisations doivent soumettre une déclaration d'intérêt via le canal indiqué sur la page de proposition de l'organisation.

Votre déclaration d'intérêt doit inclure vos coordonnées, des informations sur votre expérience de rédaction technique et un aperçu du travail que vous effectueriez avec l'organisation. Il doit également mettre en évidence la façon dont vous répondez aux exigences spécifiques de l'organisation concernant les rédacteurs techniques. Lisez attentivement la page des idées de projet de l’organisation afin de vous assurer que vous avez inclus toutes les informations dont elle a besoin.

Ce modèle est un aperçu pour vous aider à créer votre propre déclaration d'intérêt.

Informations personnelles

  • Indiquez votre nom et votre adresse e-mail. Si vous ne souhaitez pas que votre nom apparaisse dans les rapports d'étude de cas finaux disponibles au public, veuillez l'indiquer dans votre proposition et indiquez un nom d'utilisateur.

Informations professionnelles

  • Un lien vers un portfolio accessible publiquement d'exemples écrits ou des liens individuels vers des exemples de votre travail.
  • Un aperçu de votre expérience de rédaction technique récente: indiquez vos rôles ou votre expérience professionnelle de rédaction technique les plus récents. Si vous avez de l'expérience dans la documentation Open Source, mentionnez-la également ici. Résumez votre rôle, les responsabilités du poste et le travail que vous avez effectué. Indiquez les dates, le cas échéant.
  • Un lien vers votre CV ou votre curriculum vitae (CV).
  • Si l'organisation a défini certaines exigences pour le projet, ajoutez une phrase ou deux décrivant comment vous les remplissez. Par exemple : "J'ai participé à plus de six correctifs de documents en tant que rédacteur technique et j'ai dirigé trois correctifs de documents pour mon équipe chez XYZ Industries en 2018, 2019 et 2020".
  • (Facultatif) Toute autre information que vous souhaitez ajouter. Par exemple, votre intérêt pour la documentation technique, les raisons pour lesquelles vous souhaitez participer à Season of Docs ou toute autre expérience pertinente.

Énoncé du projet

  • Titre du projet. Si la page de projet de l’organisation répertorie plusieurs projets possibles, assurez-vous que le titre de votre déclaration d’intérêt reflète le projet sur lequel vous souhaitez travailler. Si vous soumettez une déclaration d’intérêt à une organisation qui n’a pas encore identifié de projets possibles, votre titre doit résumer le travail que vous proposez. Par exemple, "Créer une documentation interactive de l'API ProjectX" est préférable à "Documentation pour ProjectX".
  • Description détaillée.
    • Donnez une description de la manière dont vous aborderiez le projet que l'entreprise a indiqué sur sa page de proposition de projet.
    • Dites comment ce que vous proposez résoudra le problème ou atteindra l’objectif défini par l’organisation sur sa page de proposition de projet.
    • Incluez un résumé de toutes les discussions que vous avez eues avec les membres de l'organisation à propos du projet.
    • Faites attention à la langue et au style de votre proposition. L'entreprise Open Source peut les utiliser comme facteur d'évaluation de votre proposition.
  • Calendrier proposé
    • Donnez un aperçu général du calendrier et des phases du projet. Par exemple, vous pouvez budgétiser deux semaines pour la collecte d'informations, quatre semaines pour l'écriture, deux semaines pour l'examen et les modifications et une semaine pour la publication.
    • Inclure des attentes explicites en termes de participation et de feedback des membres du projet. Par exemple, vous pouvez indiquer que votre calendrier dépend de la réception de réponses aux requêtes dans un délai de trois jours.
  • Budget proposé
    • Nous recommandons aux rédacteurs techniques de proposer un budget pour l’ensemble du projet, plutôt qu’un tarif horaire.
    • Si possible, proposez des options pour réduire ou augmenter la portée. Par exemple, vous pouvez proposer différentes options budgétaires pour documenter les instructions de déploiement pour deux, quatre ou six plateformes.