AE PDF Manual Revision Part Two
Posted: Tue Dec 22, 2015 10:13 pm
I am opening up a part two thread as the original manual revision thread was locked.
tm.asp?m=3689581&mpage=1&key=manual%2Crevision
As can be seen in post 85 from 13 June 2015 in the original thread I provided a then status report and future intentions. The current status is as follows.
1. I upgraded to the latest official patch last week and recommenced direct work on the project.
2. The revision is locked in to the latest official update ie v.1.01.24. No notice will be taken of any beta changes made by michaelm since then. This is a non negotiable position as otherwise the project could never be finalised.
3. I am retyping from scratch the complete manual. New screenshots are being taken. This is actually quicker than trying to cut and paste into the existing PDF document.
4. The general layout of the original manual is being followed but I am adding new sections and rewriting existing sections to both improve accuracy and readability. Unknown to them yet, I have a couple of individuals in mind to send the drafts to read in order to provide feedback on ease of readability. The condition will be that the drafts are not released to nor commented on to any third parties.
5. Drafts of the first three chapters have been completed. I anticipate that I will have drafts of the first five chapters completed by the new year. When completed I will be sending the first five chapters to the devs for
(a) confirmation that the approach I have adopted in the revision is acceptable to them, and
(b) checking the code to confirm certain changes I am making are in fact completely accurate
I don't know how long it will take for the devs to respond, nor whether they will approve of my approach. In any case whilst they assess the first five chapters I will continue the revision. If I do get a negative response from the devs the project will cease from my end.
6. One of the things I have done, and why it is important for the devs to agree to the approach I am taking, is to add hyperlinks back to accurate and useful forum discussions. These are identified by the preceding [FD]. The intent is to provide context. For example, I have provided a hyperlink for players on Win 10 who have tech issues (such as slow response times). That link is provided in chapter 1 in a new section dealing with Command Line switches. Another [FD] provided in chapter 2 is on which scenario should a new player first choose to play. That way a new player can read what is in the manual (which is expanded on anyway from the original) plus see what actual players recommend. There are several other [FD] in addition to these two already inserted into the draft.
7. Currently I have another forumite checking on things which I am not in a position to do so. These are things such as use of hotkeys in a PBEM game (I don't have any PBEM games to use as a test bed) and any thing which needs to be under Win 10 as I remain on Win 7. No effort will be made to test on Win 8.1 as most of those users seem to have moved over to Win 10.
8. Currently there is no estimate as to when the project will be completed. In the last week I have been spending some 12 hours daily on checking patch notes, searching the forum, running game turns for checking purposes, on drafting etc. That rate may not be able to be sustained indefinitely but even if it were, it would still entail another two months minimum just to get the first draft of the complete manual done. That is without taking into account time spent by the devs on the drafts and any resulting rewrites necessary from their comments.
9. I have linked back to the original thread so that those earlier comments are not overlooked. This new thread can be the repository for any new, relevant comments. However lets try to not get this thread locked too.
Alfred
tm.asp?m=3689581&mpage=1&key=manual%2Crevision
As can be seen in post 85 from 13 June 2015 in the original thread I provided a then status report and future intentions. The current status is as follows.
1. I upgraded to the latest official patch last week and recommenced direct work on the project.
2. The revision is locked in to the latest official update ie v.1.01.24. No notice will be taken of any beta changes made by michaelm since then. This is a non negotiable position as otherwise the project could never be finalised.
3. I am retyping from scratch the complete manual. New screenshots are being taken. This is actually quicker than trying to cut and paste into the existing PDF document.
4. The general layout of the original manual is being followed but I am adding new sections and rewriting existing sections to both improve accuracy and readability. Unknown to them yet, I have a couple of individuals in mind to send the drafts to read in order to provide feedback on ease of readability. The condition will be that the drafts are not released to nor commented on to any third parties.
5. Drafts of the first three chapters have been completed. I anticipate that I will have drafts of the first five chapters completed by the new year. When completed I will be sending the first five chapters to the devs for
(a) confirmation that the approach I have adopted in the revision is acceptable to them, and
(b) checking the code to confirm certain changes I am making are in fact completely accurate
I don't know how long it will take for the devs to respond, nor whether they will approve of my approach. In any case whilst they assess the first five chapters I will continue the revision. If I do get a negative response from the devs the project will cease from my end.
6. One of the things I have done, and why it is important for the devs to agree to the approach I am taking, is to add hyperlinks back to accurate and useful forum discussions. These are identified by the preceding [FD]. The intent is to provide context. For example, I have provided a hyperlink for players on Win 10 who have tech issues (such as slow response times). That link is provided in chapter 1 in a new section dealing with Command Line switches. Another [FD] provided in chapter 2 is on which scenario should a new player first choose to play. That way a new player can read what is in the manual (which is expanded on anyway from the original) plus see what actual players recommend. There are several other [FD] in addition to these two already inserted into the draft.
7. Currently I have another forumite checking on things which I am not in a position to do so. These are things such as use of hotkeys in a PBEM game (I don't have any PBEM games to use as a test bed) and any thing which needs to be under Win 10 as I remain on Win 7. No effort will be made to test on Win 8.1 as most of those users seem to have moved over to Win 10.
8. Currently there is no estimate as to when the project will be completed. In the last week I have been spending some 12 hours daily on checking patch notes, searching the forum, running game turns for checking purposes, on drafting etc. That rate may not be able to be sustained indefinitely but even if it were, it would still entail another two months minimum just to get the first draft of the complete manual done. That is without taking into account time spent by the devs on the drafts and any resulting rewrites necessary from their comments.
9. I have linked back to the original thread so that those earlier comments are not overlooked. This new thread can be the repository for any new, relevant comments. However lets try to not get this thread locked too.
Alfred