[wp-docs] Developer doc to dos

Jennifer Hodgdon yahgrp at poplarware.com
Mon Mar 12 23:11:06 GMT 2007


In my continual quest to improve the documentation for developers on 
WordPress, I have made a To Do list:

http://codex.wordpress.org/JHodgdon/Dev_Doc_To_Dos

I am interested in your comments. If you are a developer who works on 
themes, plugins, or the core sections of WordPress, what do you think 
needs improvement in the Codex documentation? That could include 
navigation problems, individual articles that need some attention, or 
new articles that need to be written.

Regarding navigation, I am assuming as a starting point that a 
developer will find either Developer Documentation or Advanced Topics. 
(Lorelle?). Then, my idea is that all the links on link-listing pages 
should be relevant and also annotated, and if the user is led to 
another page of links, they should be told they are visiting a list of 
links, and that list should be something like "Central repository for 
links related to themes and templates", rather than just another 
random collection.

Also regarding navigation, I have taken "Further Reading" lists out of 
a lot of the developer articles, in order to centralize maintenance of 
link lists. For instance, if you read an article on writing a plugin, 
rather than having 3 links at the bottom for further reading, it 
should direct you back to the central list of all plugin-related links.

Anyway, please take a look at the To Do list and let me know what you 
think. Also, could those of you who are already working on improving 
specific developer-related documentation, or adding new pages, let me 
know so that I can make a note of that on the To Do list page?

Thanks,
     Jennifer


-- 
Jennifer Hodgdon

Poplar ProductivityWare * www.poplarware.com
Web Databases/Scripts * Modeling/Analysis/Palm OS Software


More information about the wp-docs mailing list