Skip to content
  • Categories
  • Recent
  • Tags
  • Popular
  • World
  • Users
  • Groups
Skins
  • Light
  • Cerulean
  • Cosmo
  • Flatly
  • Journal
  • Litera
  • Lumen
  • Lux
  • Materia
  • Minty
  • Morph
  • Pulse
  • Sandstone
  • Simplex
  • Sketchy
  • Spacelab
  • United
  • Yeti
  • Zephyr
  • Dark
  • Cyborg
  • Darkly
  • Quartz
  • Slate
  • Solar
  • Superhero
  • Vapor

  • Default (No Skin)
  • No Skin
Collapse
Code Project
  1. Home
  2. The Lounge
  3. Generate Documentation

Generate Documentation

Scheduled Pinned Locked Moved The Lounge
htmlhardwarexmlquestionannouncement
9 Posts 7 Posters 0 Views 1 Watching
  • Oldest to Newest
  • Newest to Oldest
  • Most Votes
Reply
  • Reply as topic
Log in to reply
This topic has been deleted. Only users with topic management privileges can see it.
  • M Offline
    M Offline
    Marc Soleda
    wrote on last edited by
    #1

    Hi all, finally it has arrived the painful task to documentate X| a software application which also has a hardware development involved. I'd like to do it in a way that could be easy to deliver it in different formats (richtext, pdf, html, xml, chm, ...) but with the same source data so when I'd have to make a future change/update wouldn't it mean a complex task. Do you know/use any documentation tool? Thanks in advance, Marc Soleda

    ... she said you are the perfect stranger she said baby let's keep it like this... Dire Straits

    D P M 3 Replies Last reply
    0
    • M Marc Soleda

      Hi all, finally it has arrived the painful task to documentate X| a software application which also has a hardware development involved. I'd like to do it in a way that could be easy to deliver it in different formats (richtext, pdf, html, xml, chm, ...) but with the same source data so when I'd have to make a future change/update wouldn't it mean a complex task. Do you know/use any documentation tool? Thanks in advance, Marc Soleda

      ... she said you are the perfect stranger she said baby let's keep it like this... Dire Straits

      D Offline
      D Offline
      Dalek Dave
      wrote on last edited by
      #2

      Two Words! Out Source :-D

      ------------------------------------ I try to appear cooler, by calling him Euler.

      M O E 3 Replies Last reply
      0
      • D Dalek Dave

        Two Words! Out Source :-D

        ------------------------------------ I try to appear cooler, by calling him Euler.

        M Offline
        M Offline
        Marc Soleda
        wrote on last edited by
        #3

        It's not an option ... :sigh:

        ... she said you are the perfect stranger she said baby let's keep it like this... Dire Straits

        D 1 Reply Last reply
        0
        • M Marc Soleda

          It's not an option ... :sigh:

          ... she said you are the perfect stranger she said baby let's keep it like this... Dire Straits

          D Offline
          D Offline
          Dalek Dave
          wrote on last edited by
          #4

          Not something I have ever thought of before, but Word allows richtext, pdf and web page publication. It may be somewhere to start. I know it seems simplistic, but anything started on it should be able to be picked up by more specialised tools.

          ------------------------------------ I try to appear cooler, by calling him Euler.

          L 1 Reply Last reply
          0
          • D Dalek Dave

            Not something I have ever thought of before, but Word allows richtext, pdf and web page publication. It may be somewhere to start. I know it seems simplistic, but anything started on it should be able to be picked up by more specialised tools.

            ------------------------------------ I try to appear cooler, by calling him Euler.

            L Offline
            L Offline
            leckey 0
            wrote on last edited by
            #5

            Yeah, especially if you use Word 2007 I think most of your bases should be covered.

            New Poll! Current Rant: "Four...More....Days...." http://craptasticnation.blogspot.com/[^]

            1 Reply Last reply
            0
            • M Marc Soleda

              Hi all, finally it has arrived the painful task to documentate X| a software application which also has a hardware development involved. I'd like to do it in a way that could be easy to deliver it in different formats (richtext, pdf, html, xml, chm, ...) but with the same source data so when I'd have to make a future change/update wouldn't it mean a complex task. Do you know/use any documentation tool? Thanks in advance, Marc Soleda

              ... she said you are the perfect stranger she said baby let's keep it like this... Dire Straits

              P Offline
              P Offline
              peterchen
              wrote on last edited by
              #6

              Marc Soleda wrote:

              I'd like to do it in a way that could be easy to deliver it in different formats (richtext, pdf, html, xml, chm, ...)

              For an API documentation, I'd recommend doxygen, and hacking the extra pages e.g. in frontpge or notepad or vi. For an end-user documentation, Help&Manual.

              We are a big screwed up dysfunctional psychotic happy family - some more screwed up, others more happy, but everybody's psychotic joint venture definition of CP
              My first real C# project | Linkify!| FoldWithUs! | sighist

              1 Reply Last reply
              0
              • M Marc Soleda

                Hi all, finally it has arrived the painful task to documentate X| a software application which also has a hardware development involved. I'd like to do it in a way that could be easy to deliver it in different formats (richtext, pdf, html, xml, chm, ...) but with the same source data so when I'd have to make a future change/update wouldn't it mean a complex task. Do you know/use any documentation tool? Thanks in advance, Marc Soleda

                ... she said you are the perfect stranger she said baby let's keep it like this... Dire Straits

                M Offline
                M Offline
                Member 96
                wrote on last edited by
                #7

                We use this: http://www.helpandmanual.com/[^] for exactly the reasons you state and have been very happy with it. Lately we've been leaning towards having only online html documentation as it's nice to be able to update it live for our customers and most are web connected anyway but as you can see that product can churn out all manner of formats.


                When everyone is a hero no one is a hero.

                1 Reply Last reply
                0
                • D Dalek Dave

                  Two Words! Out Source :-D

                  ------------------------------------ I try to appear cooler, by calling him Euler.

                  O Offline
                  O Offline
                  Oakman
                  wrote on last edited by
                  #8

                  Dalek Dave wrote:

                  Out Source

                  He didn't say he wanted it done badly, did he?

                  Jon Information doesn't want to be free. It wants to be sixty-nine cents @ pound.

                  1 Reply Last reply
                  0
                  • D Dalek Dave

                    Two Words! Out Source :-D

                    ------------------------------------ I try to appear cooler, by calling him Euler.

                    E Offline
                    E Offline
                    etkid84
                    wrote on last edited by
                    #9

                    outsource your mama

                    David

                    1 Reply Last reply
                    0
                    Reply
                    • Reply as topic
                    Log in to reply
                    • Oldest to Newest
                    • Newest to Oldest
                    • Most Votes


                    • Login

                    • Don't have an account? Register

                    • Login or register to search.
                    • First post
                      Last post
                    0
                    • Categories
                    • Recent
                    • Tags
                    • Popular
                    • World
                    • Users
                    • Groups