ML
    • Register
    • Login
    • Search
    • Recent
    • Categories
    • Tags
    • Popular
    • Users
    • Groups

    Software used for documentation recommendations?

    IT Discussion
    12
    58
    1952
    Loading More Posts
    • 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.
    • Fredtx
      Fredtx last edited by Fredtx

      I currently have a lot of my notes from issues I've come across and fixed saved in notepad, which is organized with different folders. Ex: Folder c:\notes\Networks\routers\watchguard\sslvpn.txt. What is a better solution where I could so a search and find what I need? Ex: search ssl vpn and find that documentation. I've been looking into One Note, but want to see what else is out there.

      Obsolesce 1 Reply Last reply Reply Quote 3
      • Obsolesce
        Obsolesce last edited by Obsolesce

        I like to use WordPress with a wiki theme, and some plugins installed to make it super easy and efficient to create documentation.

        Platform: WordPress
        Theme: WikiWP
        Plugins:

        • Members: allows granular user and role management
        • OnePress Image Elevator: allows you to paste images / screenshots directly into the editor... huge time saver
        • Responsive Lightbox: allows images or links that are clicked to 'pop out' and the background dims
        • Table of Contents Plus: automatically creates a table of contents as you see in wiki websites
        • TablePress: an excellent tables plugin... you can import Excel spreadsheets for example
        • TinyMCE Advanced: adds a lot of visual editing options
        • Disable Comments: as the name says
        • Broken Link Checker: handy to make sure no links are broken

        It's like working in MS Word or similar. Very easy and fast to document.

        Emad R 1 Reply Last reply Reply Quote 4
        • Obsolesce
          Obsolesce last edited by

          If this will be available or reachable through the public internet, there are some additional things you must do.

          If that is the case, and you decide on WP, let me know and I'll give you the few extra steps.

          FATeknollogee 1 Reply Last reply Reply Quote 1
          • Fredtx
            Fredtx last edited by

            @Tim_G

            Thanks! I'll definitely look into it.

            1 Reply Last reply Reply Quote 0
            • scottalanmiller
              scottalanmiller last edited by

              I like using a wiki for this. DokuWiki is probably the easiest to really use, no database needed. We are using wiki.js currently ourselves. Needs a database though, and is going through a lot of change before its next release.

              1 Reply Last reply Reply Quote 2
              • Obsolesce
                Obsolesce @Fredtx last edited by

                @fredtx said in Software used for documentation recommendations?:

                I've been looking into One Note, but what to see what else is out there.

                Also, OneNote is horrible for this. I'd not waste your time with it (for this purpose).

                scottalanmiller 1 Reply Last reply Reply Quote 5
                • Emad R
                  Emad R @Obsolesce last edited by

                  @tim_g said in Software used for documentation recommendations?:

                  I like to use WordPress with a wiki theme, and some plugins installed to make it super easy and efficient to create documentation.

                  Platform: WordPress
                  Theme: WikiWP
                  Plugins:

                  • Members: allows granular user and role management
                  • OnePress Image Elevator: allows you to paste images / screenshots directly into the editor... huge time saver
                  • Responsive Lightbox: allows images or links that are clicked to 'pop out' and the background dims
                  • Table of Contents Plus: automatically creates a table of contents as you see in wiki websites
                  • TablePress: an excellent tables plugin... you can import Excel spreadsheets for example
                  • TinyMCE Advanced: adds a lot of visual editing options
                  • Disable Comments: as the name says
                  • Broken Link Checker: handy to make sure no links are broken

                  It's like working in MS Word or similar. Very easy and fast to document.

                  Yh I also use WP for Intranets. But you do mention interesting plugins.

                  1 Reply Last reply Reply Quote 0
                  • scottalanmiller
                    scottalanmiller @Obsolesce last edited by

                    @tim_g said in Software used for documentation recommendations?:

                    @fredtx said in Software used for documentation recommendations?:

                    I've been looking into One Note, but what to see what else is out there.

                    Also, OneNote is horrible for this. I'd not waste your time with it (for this purpose).

                    Same here. We tried it. Okay for a one man team. But terrible for collaboration.

                    1 Reply Last reply Reply Quote 1
                    • hobbit666
                      hobbit666 last edited by

                      Something on my to do list. I'm the same text files and images saved all over the place. Need to collect them all up into one system and easier to access and find

                      scottalanmiller 1 Reply Last reply Reply Quote 0
                      • FATeknollogee
                        FATeknollogee @Obsolesce last edited by

                        @tim_g said in Software used for documentation recommendations?:

                        If this will be available or reachable through the public internet, there are some additional things you must do.

                        If that is the case, and you decide on WP, let me know and I'll give you the few extra steps.

                        I'm interested in those extra steps needed!

                        1 Reply Last reply Reply Quote 0
                        • scottalanmiller
                          scottalanmiller @hobbit666 last edited by

                          @hobbit666 said in Software used for documentation recommendations?:

                          Something on my to do list. I'm the same text files and images saved all over the place. Need to collect them all up into one system and easier to access and find

                          This is where DokuWiki is perfect. Needs a web server and PHP, but nothing else. It handles storing your docs as just text files on the filesystem. So you can back them up with GIT or SVN or just copy them somewhere. You can keep your "just files" processes, but have an organized, hosted wiki, too.

                          Fredtx 1 Reply Last reply Reply Quote 3
                          • Fredtx
                            Fredtx @scottalanmiller last edited by Fredtx

                            @scottalanmiller said in Software used for documentation recommendations?:

                            @hobbit666 said in Software used for documentation recommendations?:

                            Something on my to do list. I'm the same text files and images saved all over the place. Need to collect them all up into one system and easier to access and find

                            This is where DokuWiki is perfect. Needs a web server and PHP, but nothing else.

                            Is there a particular web host service you recommend? Go daddy?

                            Obsolesce scottalanmiller 2 Replies Last reply Reply Quote 0
                            • Obsolesce
                              Obsolesce @Fredtx last edited by

                              @fredtx said in Software used for documentation recommendations?:

                              @scottalanmiller said in Software used for documentation recommendations?:

                              @hobbit666 said in Software used for documentation recommendations?:

                              Something on my to do list. I'm the same text files and images saved all over the place. Need to collect them all up into one system and easier to access and find

                              This is where DokuWiki is perfect. Needs a web server and PHP, but nothing else.

                              Is there a particular web host service you recommend? Go daddy?

                              I use Dreamhost. It's been great the past year I've had it.

                              1 Reply Last reply Reply Quote 2
                              • Obsolesce
                                Obsolesce last edited by

                                I've heard good things about Hostadillo. I'd switch, but I don't have time and I'm paid in advance.

                                1 Reply Last reply Reply Quote 3
                                • scottalanmiller
                                  scottalanmiller @Fredtx last edited by

                                  @fredtx said in Software used for documentation recommendations?:

                                  @scottalanmiller said in Software used for documentation recommendations?:

                                  @hobbit666 said in Software used for documentation recommendations?:

                                  Something on my to do list. I'm the same text files and images saved all over the place. Need to collect them all up into one system and easier to access and find

                                  This is where DokuWiki is perfect. Needs a web server and PHP, but nothing else.

                                  Is there a particular web host service you recommend? Go daddy?

                                  Another vote for Hostadillo. Not only are they from Dallas.... but I run it 😉

                                  1 Reply Last reply Reply Quote 1
                                  • dbeato
                                    dbeato last edited by

                                    Thanks for the WIKIWP recommendation from @Tim_G

                                    black3dynamite 1 Reply Last reply Reply Quote 1
                                    • black3dynamite
                                      black3dynamite @dbeato last edited by black3dynamite

                                      @dbeato said in Software used for documentation recommendations?:

                                      Thanks for the WIKIWP recommendation from @Tim_G

                                      There are demos of what WikiWP looks like too.
                                      http://wikiwp.com/demo-wiki-page/
                                      https://wikiwp.com/demo-wiki-post/

                                      1 Reply Last reply Reply Quote 2
                                      • JaredBusch
                                        JaredBusch last edited by

                                        WikiWP is what I am leaning towards.

                                        I have Wiki.js online and tested, but it is honestly too complicated (for my other users) because of the lack of a WYSIWYG style editing.

                                        I tried to setup Grav, but it failed. Will try again later.

                                        1 Reply Last reply Reply Quote 1
                                        • black3dynamite
                                          black3dynamite last edited by

                                          WIkiWP hasn't been updated since January 27, 2016. Compatibility issue can appear with a newer version of WordPress.

                                          dbeato Obsolesce 2 Replies Last reply Reply Quote 0
                                          • dbeato
                                            dbeato @black3dynamite last edited by

                                            @black3dynamite said in Software used for documentation recommendations?:

                                            WIkiWP hasn't been updated since January 27, 2016. Compatibility issue can appear with a newer version of WordPress.

                                            Running fine on 4.9.4

                                            black3dynamite 1 Reply Last reply Reply Quote 0
                                            • First post
                                              Last post