Tools to write a documentation for product such as wordpress theme

General Web Dev
1

Are there any good tools to write documentation for a product such as Wordpress theme?

Documentation can be in HTML or PDF format?

2

I wouldn’t say it “writes” documentation but that it “generates” it. Anyway, take a look at

2 Likes
3

sir,

You are not getting point. writing whole documentation in html format is tedious and a nightmnare. any tool where we can write just like we write in wp editor and later all the documentation can be generated in th form of html template or pdf?

4

I’m afraid the tedium is unavoidable unless and until you get in the routine habit of writing the DocBlocks.

Take a look at the article I linked to, it answers some of your questions.

1 Like
5

Many Word Processors can save to PDF.
They can also save to HTML, but the mark-up is terrible.

2 Likes
6

Why not use Wordpress itself? Any half decent CMS should be able to do this for you, though you’d probably need an addon so you can output documentation content in PDF format (publish once output in any format).

1 Like
7

What is it you are looking to document exactly? If it’s for a single theme, then a tool might be overkill, and you could just comment your code.

If it’s more than that, then you could look at Hologram, Sassdocs or even Pattern Lab, but all require the effort putting into marking up your code with special comment blocks that those tools can then extract into an HTML style guide (effectively a separate site), or what have you.

1 Like
8

I believe you can write Markdown in a readme.txt and it will display really nicely on GitHub.

1 Like
9

It’s quite insistent on you doing exactly that, but I’m not at all sure how relevant that is to the topic at hand.

1 Like
10

Update →

the documentation in whatever form needs to be bundled with the theme that is the requirement by ThemeForest or mojomarketplace.

11

This topic was automatically closed 91 days after the last reply. New replies are no longer allowed.