Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #10

Open
tvroylandt opened this issue Apr 27, 2020 · 3 comments
Open

Documentation #10

tvroylandt opened this issue Apr 27, 2020 · 3 comments

Comments

@tvroylandt
Copy link
Contributor

Une question de langage.
On écrit la doc en français ou en anglais ?

Le premier sera plus utile aux utilisateurs.
Le deuxième sera plus ouvert pour montrer l'initiative à l'internationale.

@RLesur
Copy link
Member

RLesur commented Apr 27, 2020

Excellente question. Je serais d'avis d'écrire la documentation des fonctions en anglais : ce ne sera pas celle là qui sera vraiment lue (et accessoirement, je trouve que c'est plus facile d'écrire cette doc en anglais).

En revanche, avoir une documentation long format (vignette, site pkgdown ou autre) en français me semble indispensable.

@tvroylandt
Copy link
Contributor Author

Ca me va.

Pour la documentation long format, il faut a minima prévoir :

  • une vignette pour les graphiques (thème, couleurs, logo éventuellement) ;
  • une vignette pour présenter les différents outputs formats.

@MaelTheuliere
Copy link
Collaborator

Ça me va !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants