2

I just made a component that is going to be added to our platform in the next month. As such I need tu draw out some documentation for the guys that will do the integration.

Is there any class that allows me to quickly produce technical documentation or do I need do engineer it myself?

3
  • 1
    Welcome to TeX.se! Usually, we don't put a greeting or a “thank you” in our posts. While this might seem strange at first, it is not a sign of lack of politeness, but rather part of our trying to keep everything very concise. Accepting and upvoting answers is the preferred way here to say “thank you” to users who helped you.
    – alexwlchan
    Jun 26, 2013 at 12:28
  • 3
    can you give an example (say, a published book or a pdf file on the web) that shows the look of what you want? not everyone has the same idea of what such documentation should look like. (for example, the documentation for a latex package, e.g. texdoc xspace, looks different from a unix man page, looks different from a "whatever for dummies" book. that's not saying that any of these examples are appropriate for what you're doing.) Jun 26, 2013 at 12:44
  • Bouncing off of what @barbarabeeton has said, there is likely not an existing class that will be to your liking, depending on your needs. Different companies have different in-house standards, and these vary wildly from place to place. A good starting place would be to export an existing piece of documentation to PDF and then linking to it here (or, better yet, taking a screenshot and then uploading to SE's imgur account). Jun 26, 2013 at 16:58

1 Answer 1

1

The hitec document class is de­signed for use for technical doc­u­men­ta­tion. It is based on the standard article class, but was designed to have a very different look. There are a MWE here.

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .