Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
What tools exist for developing platform indepedent API Documentation?
I'm in the process of designing a proposed API, and want to write documentation in a structured and easily editable way. A lot of the answers I've seen have basically been "Use built in language specific documentation tools", but since I'm designing the API from a 'top-level', rather than implementing it, this isn't so useful. I'm looking for a CMS for API Documentation
I've seen a few suggestions to use PBWiki or Confluence, but I'm not convinced that a plain wiki is the best option, though the version control aspects are nice.
In theory, a Drupal build with CCK for API calls and Views for reading the API, but that's a bit of heavy lifting for what I'm looking for.
Is there a API Documentation Management System out there? What are the best options for writing and managing platform-independent documentation for APIs?
I've seen the related questions for this, but there has yet to be a satisfactory answer.
Any structured text language will do. I'd use latex, and troff is old school.
But you may have missed the point of the suggestion to use doxygen or whatever. If you do that, then writing the documentation is also laying down the scaffold for the eventual implementation. Better still, the example documentation will be in the same format as the eventual real documentation and, you will--of course---use source control on it, won't you? So you'll have a potted history of changes to the spec.
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
I want to be able to contribute to Google Translate on my native language (Sinhala).
Although there is an online portal (http://translate.google.com/community/) where we can contribute to the translator by translating new phrases or validating existing translations, I would like to create my own, lightweight portal (maybe an Android app) for the contribution service. However, I was unable to find any public API for the translate contribution platform, despite a thorough Google search and a full search through the Google Translator Toolkit API forum (https://productforums.google.com/forum/m/#!categories/translator-toolkit-api) (which seems to have been closed down since the end of 2012).
Currently my best hope is to mimic the request-response sequence followed by the online portal itself. For example, the following request is used by the online portal to fetch a question list for manual translation:
GET http://translate.google.com/community/question_list?sl=en&tl=si&client=t
However, it requires that all the related cookies are properly initialized and passed with the request, which would probably not be easy to mimic in a non-browser environment (such as an Android app). Hence I believe there's a better approach (maybe a yet undocumented API?) somewhere out there.
Does anyone know of any API for accessing this translation contribution feature?
Thanks in advance.
Please note: I am NOT looking for a way to improve Google Translate itself, but for contributing to the actual translation content as described under "How can I help?" in the Google Translate Community FAQ (https://docs.google.com/document/d/1dwS4CZzgZwmvoB9pAx4A6Yytmv7itk_XE968RMiqpMY/pub#h.e1ahmpftpdum).
P.S. I was initially planning to post this question on the Web Apps Stack Exchange, but after reading this post I decided to first try it here.
I'm one of the engineers behind Translate Community and I'm really excited that you want to see it on more platforms. We're currently under active development of the site and making it more accessible on mobile platforms without having to create dedicated native apps.
For the time being, we don't anticipate releasing a public API as the platform is under active development. Until we do release a public API, please don't use any http commands you find to create a separate app. Instead, just let us know how we can make the app a better experience for you and we'll work on making it better.
Thanks!
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Background
There is a hardware project going on. A hardware accelerator has been being developed by a team of students but there is no general documentation.
There are READMEs here and there, some docxs and in-code (Verilog, C and Lua) comments, but nothing else. The code is written with Vim, versioned with Git and Markdown is our friend, even if we are not on Github (yet).
Since this “thing” is growing, I feel the necessity of writing down something (user manual? developer notes?) but I don't know where to start.
Question
When someone feels the urge of documenting his project, where does it start?
More specifically, what are the generally accepted criteria to do it and what are the best tools?
My hypothetical answer
We quite clearly need both a developer and user manual. One with details of the algorithmic solutions, the other... like for monkeys.
About the tools, I believe that something like a Github Wiki would work fine, but (1) we are not on Github and (2) wouldn't be LaTeX a better way of writing stuff in order to publicise it, eventually. I know we can get our Markdown rendered in a printable way with http://www.cocowrite.com/, but is it the most efficient solution? LaTeX would be a nuisance for collaborative editing and online HTML publishing.
A partial answer can be found here: “What tools are used to write documentation?”.
Second part of the answer can be found here: “What amount of documentation is needed for a non-trivial one-man software project”
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
I learned how to find out which version of ClojureScript I'm using with lein-cljsbuild. Where can I find API documentation for cljs.core?
I had to find out about js-obj from a blog post.
I can look at the source code, but it's a large file and it's mostly clojure.core stuff.
Not exactly thorough documentation, but this cheat sheet is really quite helpful when starting out (and better than nothing!):
http://appletree.or.kr/quick_reference_cards/Others/ClojureScript%20Cheat%20Sheet.pdf
ClojureScript definitely has a documentation problem. You're actually not too bad off looking at the source; it's verbose but not too bad once you get used to it.
That said, one of the reasons nobody has produced a definitive ClojureScript API reference is that the core functions all mirror Clojure, so it would be quite a lot of redundant effort. If a function exists in both languages and doesn't work the same way, it's highly unusual and quite possibly a bug.
In practice, I find that using the Clojure API docs (or something like clojuredocs.org) coupled with very occasional forays into the source code work pretty well for 99% of my cljs work.
ClojureScript API Documentation is being worked on here:
http://cljs.github.io/api
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 7 years ago.
Improve this question
I need to develop a small Flex application that needs to access a MySQL database. Since I have little experience in server-side Java, PHP programming I would prefer to use a library/framework that allows me to write SQL queries in ActionScript/MXML.
After a bit of research, I have come across two 3rd party libraries, AS3FlexDB(free) and Adobe Flex Connector for MySQL(45$). Initial tests with AS3FlexDB are promising, but I'm a bit afraid that I'll start to work on the project only to find out that I need a full-fledged back-end after all.
Do any of you have experience with these tools? If so, are they stable enough for production? Are there any such libraries for other relational databases(PostgreSQL in particular)?
Thank you!
Lawrence
this and CRUD like this and read this
AS SQL Lib and another one CRUD
and final happiness
Flex is a UI Framework and is not designed for database interaction. I strongly recommend you reconsider the approach and learn a server side language. You'll thank yourself in the long run.
that said, another option is FlexSQL. This is the first time I've heard of the two you mentioned.
I have no idea why people keep building these libraries. It's like trying to use a screwdriver and nails together. It is, in theory possible but better tools exist.
I agree that server-side db interaction is the way to go, but nobody has mentioned the possibility of web services. Use this article to create a number of web services that your flex client can connect to directly.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
At the moment I am using Visual Source Safe (yeah yeah!) to store my Technical Specification documentation.
The actual docs are written in MS word.
If find that having the spec written in word format to be a big burden, for specs to be truly used there shouldn't be any barrier to usage and more importantly access.
If I can't quickly scan a document, hyperlink to other dependant documents or sections, what use is all this anyway?
So with that as a background:
what software exists to create truly accessable documentation? i.e. hyperlinks to other pages/sections etc? Or even queryable so I can view all documents that are dependant on module 4.5.3
Is it basically just a Wiki? Anything else?
Wikis are great for creating and maintaining specs. However, it is difficult to generate a big ol' paper document that makes a satisfying "thud" when you drop it on peoples' desks.
I've gotten by with Word. Just learn to take advantage of all the automation it has for cross-referencing, indexes, tables, pagination, etc.
I think of specs as having two audiences: decision-makers and developers. The Word documents are for the decision makers. The developers will come up with something useful later when it is time to implement the specs.
I believe Word supports the idea of sub-documents (links to other documents), however I'm not sure how well it works without VSS, much less with VSS. But it's something to look into.
A wiki is, however, pretty much what you are looking for.
Java has API docs generated by javadoc, Python has API docs generated by tools like epydoc.
What language are you working in? Have you looked for tools like javadoc or epydoc for your language?
We just started using Confluence for technical docs and notes: http://www.atlassian.com/software/confluence/
It's a full-featured browser-based wiki that just works out-of-the-box, though you can tweak it to your heart's content. It features everything you'd expect from a professional wiki, including security, rich text, hyperlinks, and attachemts; and it's intuitive enough that even our non-technical people (with 3-letter titles starting with 'C') use it.
If you visit Atlassian's web site (see link above), you can play with their online demo ... and they eat their own dogfood to provide community support.