-
Notifications
You must be signed in to change notification settings - Fork 0
general
Pedro Felix edited this page Feb 24, 2018
·
1 revision
-
The project technical documentation should be written using the English Language, namely on the projects that are going to be released as open source in the future.
-
The proposal, progress report, and final report, can be written using the English Language or the Portuguese Language.
-
I prefer that the students use a plain text based editing system, such as asciidoc or LaTeX, in alternative to WYSIWYG (what you see is what you get) editors such as Microsoft Word.
- They fit better in a writing workflow that resembles the development workflow (GIT for source control, pull requests, easy difference visualisation).
- Is is easy to manage references to external documents, code samples and figures.
- They typically produce documents with a more "polished" look, without too much configuration.