How to document a software

9y1.2kLearn iOS Programming

i work with fotnet technology to develop web and windows application. so i like to know what would be the best approach to document a software when we develop with dotnet technology.

what are the approaches taken by mid and big software house to document a software what they develop.

please guys share your suggestion and recomendation. thanks

3 Replies

Know the answer? Post it — somebody with the same question will find it here.

Fabio Silva Lima9y ago
Accepted answer
Hello!

You can enable this in your project properties, build tab:

This will generate xml help files with your documentation and you can use other plugins and softwares to read those xml files and generate a PDF documentation.

https://msdn.microsoft.com/pt-br/library/x4sa0ak0(v=vs.100).aspx
+1
9y ago
you said "You can alse generate a DOC file with all those documentation." please tell me how to generate doc file from xml documentation from VS IDE ?

what best format and practise exist to document a software because if any team member leave company without hand over his job then we can refer his doc format to understand the flow of his module ?

how to document UI too.

please answer for my 3 question in details. thanks
+1
Fabio Silva Lima9y ago
Hello how are you doing?

So, the first question is? What kind of documentation? User interface, technical stuff, installation or all kind of documentation?

If you want to document your code you can start using of visual studio built documentation with "comments" above methods, classes, variables and so on... open/close
, check it out bellow. You can alse generate a DOC file with all those documentation.
///

        /// This method do something
        ///
        /// the client model interface to use as entry point
        /// returns a page
        public async Task SetEntrada(ICliente cliente)
        {
            _vm.NotifyLoadingIfUniqueId(cliente.ID);

            await ConsultarCliente(cliente.ID);

            if (_vm.Cliente.PossuiAgregado)
            {
                await ConsultarAgregado(cliente.Agregado);
            }

            return this;
        }
+2