App Guidelines: Difference between revisions

From GCD
Jump to navigation Jump to search
(Created page with "So, you are developing an application re-using the GCD data? Great! We want our work to be useful for as many people and as widely as possible. To ensure a good experience for...")
 
No edit summary
Line 7: Line 7:
Making the relationship between the data you are using and the GCD project clear to your users is not only a legal requirement, but it's also mutually beneficial. This way, errors or omissions in our data can be pointed out to us, so that our completness and accuracy improves as more people work with the GCD, and in turn you get both better data in the future as well as more satisfied users who know how they can fix problems with the source information.
Making the relationship between the data you are using and the GCD project clear to your users is not only a legal requirement, but it's also mutually beneficial. This way, errors or omissions in our data can be pointed out to us, so that our completness and accuracy improves as more people work with the GCD, and in turn you get both better data in the future as well as more satisfied users who know how they can fix problems with the source information.


On the other hand, please make sure that users are at least briefly made aware of the best best way to contribute back to the GCD.
On the other hand, please make sure that users are at least briefly made aware of the best best way to contribute back to the GCD when you point them our way. Becoming indexers and making fixes or additions directly through our [[Indexing|Online Indexing (OI)]] interface is the best and ensures that their contributions are incorporated to the GCD data in the most direct and efficient way. In comparison, [[Error Tracker FAQ|submitting an error report]] or contacting us via [mailto:[email protected] email] means that the report has to be handled by other overworked indexers or editors and will naturally take longer.
 
Please also make sure that the way GCD information is used in your app doesn't confuse users. Our original aim is documentation and research and our data isn't necessarily organized and presented in the optimum way for those using it, for instance, to track their collections, create an on-line comic shop, create statistics, or any of various other areas of interest. Some possible gotchas:
 
* For series, the name as appears in the indicia takes precedence and in general series are split when their title changes. This might mean that users might not find all the books they're looking for in the same series or under the title they first try to search for
* The GCD search interface is somewhat inflexible and, for example, punctuation marks might cause a seach to fail. We encourage you to create a better search system inside your app if appropriate, or compare series names by giving less weight to punctuation, articles and prepositions.
* Publishers are a complicated topic and our model, while comprehensive, might not match exactly what you have in mind - please see the [[User's Guide to Publishers]]

Revision as of 18:44, 2 October 2012

So, you are developing an application re-using the GCD data? Great! We want our work to be useful for as many people and as widely as possible. To ensure a good experience for users of your app as well as a productive co-operation with the GCD Project, the following guidelines might be of interest.

Make sure users know the origin of the data

First of all, you've read our Data Distribution page, right? In particular, the Creative Commons Attribution license, under which the data is available, requires that information coming from us is credited to the Grand Comics Database, and a link back to the appropriate page in our site is provided if possible.

Making the relationship between the data you are using and the GCD project clear to your users is not only a legal requirement, but it's also mutually beneficial. This way, errors or omissions in our data can be pointed out to us, so that our completness and accuracy improves as more people work with the GCD, and in turn you get both better data in the future as well as more satisfied users who know how they can fix problems with the source information.

On the other hand, please make sure that users are at least briefly made aware of the best best way to contribute back to the GCD when you point them our way. Becoming indexers and making fixes or additions directly through our Online Indexing (OI) interface is the best and ensures that their contributions are incorporated to the GCD data in the most direct and efficient way. In comparison, submitting an error report or contacting us via email means that the report has to be handled by other overworked indexers or editors and will naturally take longer.

Please also make sure that the way GCD information is used in your app doesn't confuse users. Our original aim is documentation and research and our data isn't necessarily organized and presented in the optimum way for those using it, for instance, to track their collections, create an on-line comic shop, create statistics, or any of various other areas of interest. Some possible gotchas:

  • For series, the name as appears in the indicia takes precedence and in general series are split when their title changes. This might mean that users might not find all the books they're looking for in the same series or under the title they first try to search for
  • The GCD search interface is somewhat inflexible and, for example, punctuation marks might cause a seach to fail. We encourage you to create a better search system inside your app if appropriate, or compare series names by giving less weight to punctuation, articles and prepositions.
  • Publishers are a complicated topic and our model, while comprehensive, might not match exactly what you have in mind - please see the User's Guide to Publishers