Bug 994794
| Summary: | Suggestions for documentation improvement. | |||
|---|---|---|---|---|
| Product: | [Community] Publican | Reporter: | Leslie Satenstein <lsatenstein> | |
| Component: | publican | Assignee: | Ruediger Landmann <rlandman> | |
| Status: | CLOSED NOTABUG | QA Contact: | Ruediger Landmann <rlandman> | |
| Severity: | low | Docs Contact: | ||
| Priority: | unspecified | |||
| Version: | 3.2 | CC: | aigao, me, mmcallis, pbokoc, rlandman, zach | |
| Target Milestone: | --- | |||
| Target Release: | --- | |||
| Hardware: | All | |||
| OS: | Linux | |||
| Whiteboard: | ||||
| Fixed In Version: | Doc Type: | Bug Fix | ||
| Doc Text: | Story Points: | --- | ||
| Clone Of: | ||||
| : | 1029712 (view as bug list) | Environment: | ||
| Last Closed: | 2014-09-22 22:45:57 UTC | Type: | Bug | |
| Regression: | --- | Mount Type: | --- | |
| Documentation: | --- | CRM: | ||
| Verified Versions: | Category: | --- | ||
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | ||
| Cloudforms Team: | --- | Target Upstream Version: | ||
| Embargoed: | ||||
| Bug Depends On: | ||||
| Bug Blocks: | 1029712 | |||
|
Description
Leslie Satenstein
2013-08-08 03:10:09 UTC
The "Typographic Conventions" content is defined by publican, the publishing tool used to create the guide. In the installation guide, I noted that chapter two and following that "the discussion is about downloading the various versions of Fedora (netinstall, dvd, etc)." Then aas a follow up, there is a long discussion about which version of Fedora is the one to select from a list of options based on architecture and the like. Should not the latter documentation section precede the downloading information? As the comments in the guide were "for new users of Linux and experienced ones", the guide may (in my opinion) be presenting information that the individual should know about before downloading or acquiring any version. Most users of technical manuals do a two pass read. The first read is to get an appreciation of the product and guide, and the second pass is to follow the recipe. By following the recipe, it should be a) step one, determine your version and suitability of hardware b) step two determine the version of Fedora you want to install (32bit/64bit) etc. c) Download/acquire .... and so forth. The guide is almost in the step by step recipe sequence, If you go forward, would the improvements be present before Fedora 20,so the new sequence could be ready for a reviewer and his comments? And if you keep the sequence, I presume the update draft would also be ready for the reviewers and their comments. In the installation guide, I noted that chapter two and following that "the discussion is about downloading the various versions of Fedora (netinstall, dvd, etc)." Then aas a follow up, there is a long discussion about which version of Fedora is the one to select from a list of options based on architecture and the like. Should not the latter documentation section precede the downloading information? As the comments in the guide were "for new users of Linux and experienced ones", the guide may (in my opinion) be presenting information that the individual should know about before downloading or acquiring any version. Most users of technical manuals do a two pass read. The first read is to get an appreciation of the product and guide, and the second pass is to follow the recipe. By following the recipe, it should be a) step one, determine your version and suitability of hardware b) step two determine the version of Fedora you want to install (32bit/64bit) etc. c) Download/acquire .... and so forth. The guide is almost in the step by step recipe sequence, If you go forward, would the improvements be present before Fedora 20,so the new sequence could be ready for a reviewer and his comments? And if you keep the sequence, I presume the update draft would also be ready for the reviewers and their comments. Please Close |