20,741
edits
Volunteer: Difference between revisions
Jump to navigation
Jump to search
→Documentation Editors/Reviewers
No edit summary |
|||
| Line 60: | Line 60: | ||
It lies in the nature of FlightGear development that The Manual is always a bit behind current development. We invite you to pick information from a) your personal experience with FlightGear, b) the available README's in the FlightGear source tree or the Base Package or c) the Wiki and merge these into an appealing shape for The Manual. Turn your head to the FlightGear developers' [[mailing list]] and you'll find someone to talk about how to improve The Manual. | It lies in the nature of FlightGear development that The Manual is always a bit behind current development. We invite you to pick information from a) your personal experience with FlightGear, b) the available README's in the FlightGear source tree or the Base Package or c) the Wiki and merge these into an appealing shape for The Manual. Turn your head to the FlightGear developers' [[mailing list]] and you'll find someone to talk about how to improve The Manual. | ||
Currently, some of the other documentation that comes with FlightGear is lacking, terse or simply inaccurate (outdated) in various places due to the advances in FlightGear's code since the time when the original documentation was written | Currently, some of the other documentation that comes with FlightGear is lacking, terse or simply inaccurate (outdated) in various places due to the advances in FlightGear's code since the time when the original documentation was written. | ||
As a documentation editor/reviewer, it would be your task to check the current documentation and identify areas for improvement. Preferably you should also be able to directly make corresponding suggestions for augmentations, or even write new help documents altogether (possibly based on evaluating recent mailing list discussions). You would be expected to thoroughly check the documentation folder ([[$FG ROOT]]/Docs) and review all relevant documentation for obvious shortcomings or mistakes, smaller corrections shall be sent by email to the developer mailing list, preferably in unified diff format (for patch to work). | As a documentation editor/reviewer, it would be your task to check the current documentation and identify areas for improvement. Preferably you should also be able to directly make corresponding suggestions for augmentations, or even write new help documents altogether (possibly based on evaluating recent mailing list discussions). You would be expected to thoroughly check the documentation folder ([[$FG ROOT]]/Docs) and review all relevant documentation for obvious shortcomings or mistakes, smaller corrections shall be sent by email to the developer mailing list, preferably in unified diff format (for patch to work). | ||