-
Notifications
You must be signed in to change notification settings - Fork 0
Requirements List
This requirements list comes from feedback from the Publishers Summit.
I've created a 'to do' issue record for each of the requirements (you can click on the #1, #2, ... after their title to visit those issues records). They're like 'job tickets'.
The idea is that each of these issues is a starting point; some of these will be split up in multiple sub-tasks (e.g. 'Dramatically Clean up CSS' will have to be separated into multiple courses of action that all contribute to the end-result).
A few basic rules:
-
Avoid email. Any information that can be put into one of these GitHub issues should be there. If you put it in an email it will get lost and won't be visible to all stakeholders. If you put it in a GitHub issue, it becomes part of a searchable database with project-related info.
-
Please attach any relevant info and sample files to the correct issue. If you have sample files, screenshots,... please attach them to the issue. Some file formats are not accepted, but simply .ZIP-ping them up will allow you to work around that problem.
-
Split up issues into smaller issues whenever you can. Often, when creating or adjusting an issue record, you'll have an urge to add multiple 'to do' items. If you see that an issue has become a 'to do' list with multiple sub-tasks, please split it up. E.g. if you feel tempted to create an issue in the vein of:
Please fix the problems:
- Text should be right-aligned
- InDesign crashes when running
- When you have time, the output file name should end in '.bla'.
that needs to be split into three different issues.
Otherwise, it becomes very hard to decide when a problem is fixed. If we leave the above as a single issue record, it might be that items 1 and 2 are actually fixed, but the minor sub-issue 3 is not, so the whole issue-record remains 'not done'. By splitting it, we have three issue records, two of which are done, and one remaining not done yet, but low priority
- Clean out InDesign overrides on character, paragraph, cell, and object styles. #1
- Add a meaningful title to the HTML file. #2
- Clean up the CSS dramatically. #3
- Add schema.org metadata to the OPF file. #4
- Swap out generic HTML for more semantic tags, specifically <section>, <blockquote>, <figure> and <figcaption>, and <cite>. #5
- mapping epub:type semantics to ARIA roles #6