Click here to Skip to main content

Submit your article

Documentation

documentation

Great Reads

Documenting Your Project Using the Eclipse Help System

by Eduardo Mozart de Oliveira

Any project can use a cut-down version of the platform to provide professional, easy-to-use, and searchable documentation

Convincing Stakeholders of Necessity of System Creation and/or Code Changes

by raddevus

7 step outline will help you communicate quickly and clearly to team about System Creation / Code Changes

Mkdoc over Confluence for Indie Project Documentation

by Jason Sultana

An argument for using mkdoc to store local docs instead of using a tool like confluence

SDK Documentation Inconsistency: Supported Kerberos Token Claims Types

by Bruno van Dooren

When retrieving claims information from user token, SDK documentation concerning the supported data types is incorrect.

Latest Articles

Using Mermaid in Azure DevOps

by Wessel Beulink

As someone who frequently employs Logic Apps – Azure’s fantastic low-code solution – I’ve come to appreciate its wide range of actions and connectors. One of the keys to this balance? Solid documentation!

New Azure API Center Portal

by Wessel Beulink

Azure API Center Portal streamlines API management; Visual Studio Code extension enhances collaboration and productivity within Azure ecosystem.

Azure’s New Private Subnet

by Wessel Beulink

Microsoft Azure enhances security with private subnets, fostering efficient network management.

SDK Documentation Inconsistency: Supported Kerberos Token Claims Types

by Bruno van Dooren

When retrieving claims information from user token, SDK documentation concerning the supported data types is incorrect.

All Articles

Documentation

Cons of C# documentation

5 May 2020 by phil.o

Documentation is just technical information about the objects and structures of the framework; it is not bound to C#, as there are other languages using the same framework. Documentation is not the best choice to learn C#. If I had to make an...

Documenting Your Project Using the Eclipse Help System

30 Aug 2018 by Eduardo Mozart de Oliveira

Any project can use a cut-down version of the platform to provide professional, easy-to-use, and searchable documentation

What documentation / software is being used to create these articles?

20 Apr 2016 by Jochen Arndt

It is just HTML using CodeProject specific style sheets (CSS). The online article editor will insert the specific style names when using the format options on top of the editor. When using the editor in source mode, these styles must be set manually as described in the Article Formatting tips...

Cons of C# documentation

5 May 2020 by Maciej Los

In contrast to the disadvantages... It's not that bad... Several positive aspects of programming language documentation can be mentioned (based on Tuple class[^]): 1. there you'll find the definition of class/method/event: public static class...

Cons of C# documentation

5 May 2020 by RickZeeland

The problem with .NET is that there is a lot of documentation, but also a lot of bad or old documentation. Maybe you can find something here: resources-to-learn-net[^] best-resources-for-a-programming-beginner-to-learn-c[^]

Convincing Stakeholders of Necessity of System Creation and/or Code Changes

2 May 2021 by raddevus

7 step outline will help you communicate quickly and clearly to team about System Creation / Code Changes

Mkdoc over Confluence for Indie Project Documentation

31 Jul 2021 by Jason Sultana

An argument for using mkdoc to store local docs instead of using a tool like confluence

Are there any techniques/software that can search accurately in spite of bad quality scan documents (and subsequent OCR errors)?

24 Jan 2022 by Dave Kreskowiak

"Bad quality" is not exactly an exact measurement, so the question is really "are there any OCR tools that are better at text conversion with poorer quality scanned documents?" Well, all that depends on how bad the quality of the scanned...

SDK Documentation Inconsistency: Supported Kerberos Token Claims Types

6 Oct 2022 by Bruno van Dooren

When retrieving claims information from user token, SDK documentation concerning the supported data types is incorrect.

active-directory

New Azure API Center Portal

1 Feb 2024 by Wessel Beulink

Azure API Center Portal streamlines API management; Visual Studio Code extension enhances collaboration and productivity within Azure ecosystem.

Convert Sandcastle (or xml comments) to word

9 Feb 2015 by Duncan Edwards Jones

HiI use XML documentation in code and Sandcastle (with SHFB) to create windows help files (chm) but now the powers that be are looking for a word document instead. Any ideas/links/pointers or do I need to fork and code this myself?

XML-documentation

Convert Sandcastle (or xml comments) to word

9 Feb 2015 by Richard Deeming

I've not used it, but Doxygen[^] claims to support RTF output.Otherwise, there are a couple of commercial products listed on this SO thread[^].

XML-documentation

Convert Sandcastle (or xml comments) to word

9 Feb 2015 by Yesii

Similar question, you can refer this:http://stackoverflow.com/questions/48381/generating-documentation-from-c-sharp-xml-comments[^]

XML-documentation

UI database spreadsheet that maps every element on the Ui with the tables and column names

22 Feb 2015 by imastu

My boss given me an assignment related to code documentation.He asked to me"Can you also start writing the UI database spreadsheet that maps every element on the UI with the tables and column names"I am unable to understand how I can achieve this.I have searched on Google but didn't...

UI database spreadsheet that maps every element on the Ui with the tables and column names

25 Feb 2015 by imastu

Please anybody reply this question.I shall be very thankful to him/her.Thanksimastu

Trying to build new Document management system.

26 Mar 2015 by Sascha Lefèvre

Alright, I asked my bookmarks folder for you.. here you...

Trying to build new Document management system.

26 Mar 2015 by Sergey Alexandrovich Kryukov

Please see: http://en.wikipedia.org/wiki/%22Hello,_World!%22_program. :-)—SA

Creating documentation in C# using visual studio and sandcastle

9 May 2016 by .net developer123456789

Whats the update on documentation for VS projects. Is Sand Castle still the norm, or is there another better tool out there for documentation?

Creating documentation in C# using visual studio and sandcastle

21 Apr 2016 by RickZeeland

Of the free solutions available for me Sand Castle is the norm, I can recommend Sandcastle Help File Builder:GitHub - EWSoftware/SHFB: Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for...

Creating documentation in C# using visual studio and sandcastle

9 May 2016 by Dmitriy Gakh

For now I selected two tools to use for documenting and commenting code in my projects in Visual Studio 2015 - Sandcastle and GhostDoc.Sandcastle is continuously developing and is quite powerful tool. It is free and open source. I think frequent code commits is an evidence of its...

Can I add custom XML tags for documendation in sandcastle help file builder ?

3 Oct 2016 by David_Wimbley

I suggest you look over the sandcastle documentation and do some research. Google is your friend.Here are some links to review:Supporting Custom tags in Sandcastle – Sandcastle[^]Google[^]GitHub - EWSoftware/SHFB: Sandcastle Help File Builder (SHFB). A standalone GUI, Visual...

How to write a 'system spec' for an app based on a business spec.

18 May 2017 by CHill60

Not really something that can be answered in a "quick" answers forum! You've mentioned "user stories" so I'm guessing it's an Agile environment - have a look at this An Agile Functional Specification - its-all-design.com[^] There's some more formal stuff on this site ... or this specific...

Generate activity diagram from source code.

24 Oct 2017 by Richard MacCutchan

generate some UML - Google Search[^].

How to document a software development project

25 Feb 2018 by Member 13493077

I'm to start working on a new project. the biggest l have ever undertaken. Do l include; flow diagrams, DFD? Any leads on how best to document this? Thnx Ronald What I have tried: I have developed basic documents in the past. I however feel it is not suitable for this.

How to document a software development project

25 Feb 2018 by RDBurmon

read this - Software documentation - Wikipedia[^] There are many types of documents you can create - 1) Business requirement document - plot of your project - this contains client requirement and proposed model of your software (rough work and may be pseudo code) 2) Technical document -...

How can I convert specific web page to markdown or asciidoc with pandoc?

7 May 2018 by Member 13815917

I want to convert java specification documentation to easily editable formats(markdown or asciidoc) and upload GitHub Gist and customize(adding my code experiences and notes.) I want to convert to something like this I use a tool called pandoc that allows us to convert from HTML to markdown. ...

How to make script macros making footnote on docs ?

15 Jul 2020 by ZurdoDev

First decide if you are using Office Word or you are using Google docs because the approach is very different. Secondly, it will be much easier to do this by hand than it will be to try and write code that can guess what part needs to be...

Phpdocumentor does not generate any documentation

5 Jul 2022 by Dario de Judicibus

I found the cause of that bug. It is related to the fact that the path contains a has character, that is #MyProject. phpDocumentor change it to %23MyProjects and then create the %23MyProject folder in the filing system.

Phpdocumentor does not generate any documentation

5 Jul 2022 by Dario de Judicibus

I have a serious problem with phpDocumentor in a WampServer based development environment on Windows 10 Pro. The code I developed contains the phpDoc blocks needed to produce the documentation. To do this I used a Visual Studio Code plugin. Now,...

Using Mermaid in Azure DevOps

1 Mar 2024 by Wessel Beulink

As someone who frequently employs Logic Apps – Azure’s fantastic low-code solution – I’ve come to appreciate its wide range of actions and connectors. One of the keys to this balance? Solid documentation!

Azure’s New Private Subnet

5 Jan 2024 by Wessel Beulink

Microsoft Azure enhances security with private subnets, fostering efficient network management.

Timing is Everything

4 Feb 2018 by V.

A guide to estimating work and time for a project

project-management

Constructing Documents

10 Sep 2021 by Mark_Wallace

A simple and extremely efficient method for saving yourself a lot of pain when writing documentation

WSDL Equivalent for Rest API

3 Dec 2015 by Kanivalan Raju

Generate User Interface for Web API that lists down all the http services without writing a single line of code

How do I document the getextent post condition

17 Apr 2020 by Member 14654526

/** * Initializes this shape group with the given shape. * @creates | xarray * @creates | yarray * @mutates | this * @post | getShape() == shape * @post | getExtent() == Extent.ofLeftTopRightBottom(xarray[0], yarray[0],...

What documentation / software is being used to create these articles?

20 Apr 2016 by Member 11080324

I am new to this site and have enjoyed read many of the articles.They all seem to be created using the same documentation / software product.What is it?What I have tried:At this point I have not tried anything!

How to write a 'system spec' for an app based on a business spec.

18 May 2017 by Brady Kelly

I suppose what I'm actually asking for is at best a template, then some suggestions of what areas I must specify. I have a business spec in terms of user stories together with additional validation rules etc. per story. I think my spec, which should be divided into front and back-end, for two...

Cons of C# documentation

5 May 2020 by sOwlO

I am programming for few months. And I dont understand why the documentation for c# is so bad! Is that with every language? When I am looking for answers I must always look everywhere else, than in docs. I almost always find out the answers in...

Are there any techniques/software that can search accurately in spite of bad quality scan documents (and subsequent OCR errors)?

24 Jan 2022 by Stella Merchant

I am not able to search for key information as Google only supports exact match. However, due to OCR errors, the OCR text would not exactly represent the text in PDF documents. Are there any techniques/software that can search accurately in spite...

Require help In Documentation of my project can anybody help in pin-pointing the mistake in my dfd and the corrections required ?

5 May 2015 by Member 10820379

Here are the dfd that i made please help.https://drive.google.com/open?id=0B-gRpss4Z5xJfkF6M3U1RUZqeHcwYS0wclVYcUNkTXVRVktNc0xsSE1TOVB4WHdQUVhrTlE&authuser[^]any reference to how to make correct dfd's would also be appreciated.DFD-(DATA-FLOW-DIAGRAM)

project-management

Can I add custom XML tags for documendation in sandcastle help file builder ?

3 Oct 2016 by Member 12766428

Hi... Friends..I am new to sandcastle help file builder , i am given a task to include custom XML tags and that should reflect in help file by sandcastle....need some ideas..... can anyone help me...?What I have tried:''' ''' '''