IHateMyJob2004
Lifer
This is regarding Java. Please read as the subject is hard to state accurately.
This is an interesting situation. We are using a highly complex API. This thing is HUGE and the learning curve is steep. The thing is, we need maybe 5% of the API. But this is still a large chunk of the API in terms of class/method count.
I've been wanting to create a FAQ for a while. But the FAQ would have to be organized into categories and in those categories it would tell you if you want to do A, here is some example code in code block B.
It would also have to cover best practices and be dynamic regarding this. We have done things at the beginning with the API and then realized 2 years later that we did it wrong.
We also want to encapsulate some functionality via the Proxy pattern and document that in the same FAQ. We are writing proxies to take low level code from the API and encapsulate it at a higher level in a common "core" project to make it easier for people to use the API and lessen the learning curve.
I keep saying FAQ but it is more of a custom programmers guide for the API.
What is the best way to approach this that can be written quickly? web based would be nice but that might be a slow process to author. We could use a Word document (1 or many). But is there any existing utility that does what I am looking for before I just start using a word document?
This is an interesting situation. We are using a highly complex API. This thing is HUGE and the learning curve is steep. The thing is, we need maybe 5% of the API. But this is still a large chunk of the API in terms of class/method count.
I've been wanting to create a FAQ for a while. But the FAQ would have to be organized into categories and in those categories it would tell you if you want to do A, here is some example code in code block B.
It would also have to cover best practices and be dynamic regarding this. We have done things at the beginning with the API and then realized 2 years later that we did it wrong.
We also want to encapsulate some functionality via the Proxy pattern and document that in the same FAQ. We are writing proxies to take low level code from the API and encapsulate it at a higher level in a common "core" project to make it easier for people to use the API and lessen the learning curve.
I keep saying FAQ but it is more of a custom programmers guide for the API.
What is the best way to approach this that can be written quickly? web based would be nice but that might be a slow process to author. We could use a Word document (1 or many). But is there any existing utility that does what I am looking for before I just start using a word document?
Last edited:
