Search Results

Search found 8543 results on 342 pages for 'documentation'.

Page 27/342 | < Previous Page | 23 24 25 26 27 28 29 30 31 32 33 34  | Next Page >

• How to create a "dependency graph" for IT assets

  - by p.marino

  One of my customers is trying to create an interactive "matrix" of interdependencies for the various applications used in their company (it's a travel&leisure company with around 2500 employees). The idea (still at the prototype stage) is to create a sort of Map, based on Visio or similar tool, which traces the communication and interdependencies between all the IT assets in the company, so that when someone asks for a change they can get an overview of the impacts. This was mentioned in a casual setting and it will not be my responsability to directly work on this, but I did contribute the little I know already in terms of vaguely related methodologies (Zachman Framework). I'd like to hear from the people in here if they know of methodologies, or tools, that may help this kind of effort, and if they have any specific experience to contribute. I'll digest the answers and send the result back to my customer, hoping this may be of some help with their task (which I consider a bit visionary and prone to all the pitfalls of any documentation project, but still well worth pursuing).

  Read the article

• What do gurus say about Requirements Traceability Matrix?

  - by Jaywalker

  Our organization is at CMMI Level 2, and as part of the requirements of the level, we have to maintain an RTM which more or less contains the following entries for each requirement: Requirement Description Reference Section Functional Specification Document Reference Section Design Document Reference Section Test Cases Document Now, this might be an overkill for a small project. But more importantly, this could be a nightmare to maintain when the requirements/ features keep changing, and documents have to be constantly updated. What do the gurus say about this? Should one avoid such level of documentation or are there any tools to manage when a "change" out dates so many artifacts? And by using the term 'gurus', I am not talking of coding champs; rather people like Steve McConnel or others who have worked on commercial projects of medium to large scale. Quotes/ book references/ articles will suit me. EDIT: It's not just requirements that change. Design Document can change; well, even test cases may change.

  Read the article

• Are there some good and modern alternatives to Javadoc?

  - by ivan_ivanovich_ivanoff

  Let's face it: You don't need to be a designer to see that default Javadoc looks ugly. There are some resources on the web which offer re-styled Javadoc. But the default behaviour represents the product and should be as reasonably good-looking. Another problem is the fact that the usability of Javadoc is not up-to-date compared to other similar resources. Especially huge projects are hard to navigate using Firefox's quick search. Practical question: Are there any standalone (desktop) applications which are able to browse existing Javadoc in a more usable way than a browser would? I'm thinking about something like Mono's documentation browser. Theoretical question: Does anyone know, if there some plans to evolve Javadoc, in a somehow-standardized way? EDIT: A useful link to Sun' wiki on this topic.

  Read the article

• Looking for a wiki-style, standalone, version-control-"safe" documenation package

  - by basszero

  This may sound like it's not a programming related question, but stick with me here... My team and I have found that documenting our project (a development platform w/ API) with a wiki is both useful to us and useful to the users. Due to some organizational issues, we're forced to do multi-site development without network connectivity. We've switched to a DVCS (Mercurial) and had great success with this. The wiki documentation proves to be a problem as the central site is setup with MediaWiki. The offsite people have no way to access or edit the wiki. Is there any sort of wiki-style package which doesn't not require a server/database and will be useable in a DVCS environment? Update: Should be open-source and cross-platform

  Read the article

• Visual Studio add-in to support images inline with source?

  - by Jesse Stimpson

  We use Visual Studio 2005 here, and in an attempt to improve the documentation of our source, we're looking for a Visual Studio add-in that will allow images to be viewed in line with source from within the IDE. For example, the use case I'd like to fit is the following: In the directory in which my source lives, I save my image file my_image.png. In the source file, I write a comment of the form /// @image my_image.png The add-in allows me to toggle between seeing the text /// @image my_image.png and viewing the actual image within the code editing window, inline with whatever source surrounds it. Does anyone know of an existing add-in for VS 2005? If not, does the VS add-in api allow for such functionality? Thanks!

  Read the article

• should I use LaTeX and why (not)?

  - by ptrn

  I'm a student, and just finished this last semester. This summer I will be working on a project that will require a lot of documentation and reports, and I'm shivering every time I think of styling in either Word or OpenOffice. I've been wanting to learn LaTeX for a while, but I can't help but think; is it worth it? Does anyone actually use it except for academics? Is it worth taking the time it takes to learn to use it efficiently? What are the pros and cons?

  Read the article

• docs/examples on libxml2 type system?

  - by Wang

  I'm reading through the libxml2 API and examples on xmlsoft.com and having some real difficulty wrapping my head around the type system. For example, the _xmlAttribute struct has an xmlChar* field called name. This obviously refers to the name of the attribute (e.g., "bar" for the struct tied to the element <foo bar='baz' />). The _xmlAttribute struct also has a field called value, which I would expect to be "baz", except the type is xmlNodePtr. Um, what? I guess I could write up some test code and examine the memory in gdb, but there has to be an easier way. Has anyone written up examples of the data structures generated by a libxml2 parser? I'm looking for an English prose text, not generated documentation, that will walk me through the various types and the values they take when parsing some example bit of XML. Bonus points if it presents only the subset of libxml2 needed to read and write a config file---no namespaces or XPath or even modifying an existing document, just parse some XML, access the data, and then write it out again.

  Read the article

• Team Foundation Server - A programmer's guide

  - by Filip Ekberg

  In addition to my Previous topic on How to use SVN, Branch? Tag? Trunk? I would like to get in-depth on how a programmer should/could use TFS. The things that are most interesting to me is not how to set up the server, rather how you use it on a daily basis. In the area of software engineering where your responsibility not only lies on code but achitecture, documentation and other fields, you need to have a collection of your work, prefferably on the same place. So these are my point of interest which I would like to get more knowledge about How would you strucuter a TFS Workspace / Project to support lots of different customers / projects and maybe different projects per customer? Splitting up the folder strucutre on the above project into different pieces such as, Code, Documents - Architecture, Requirements and other, what more could there be and what would be a nice commonly used folder structure? An easy to browse repository; Again the folder structure here is important however this point is more aimed at different Explorers for the repository, not only the built in Team Foundation Explorer. These are just a couple of the points that I would like to know more about, suggestions on Beginners guides, in-depth guides and links covering the above would be very much helpful, please feel free to add other important knowledge-points to this as well.

  Read the article

• [Doxygen] How to documenting global dependencies for functions?

  - by Thomas Matthews

  I've got some C code from a 3rd party vendor (for an embedded platform) that uses global variables (for speed & space optimizations). I'm documenting the code, converting to Doxygen format. How do I put a note in the function documentation that the function requires on global variables and functions? Doxygen has special commands for annotating parameters and return values as describe here: Doxygen Special Commands. I did not see any commands for global variables. Example C code: extern unsigned char data_buffer[]; //!< Global variable. /*! Returns the next available data byte. * \return Next data byte. */ unsigned char Get_Byte(void) { static unsigned int index = 0; return data_buffer[index++]; //!< Uses global variable. } In the above code, I would like to add Doxygen comments that the function depends on the global variable data_buffer.

  Read the article

• How to document an accessor/mutator method in phpDoc/javaDoc?

  - by nickf

  Given a function which behaves as either a mutator or accessor depending on the arguments passed to it, like this: // in PHP, you can pass any number of arguments to a function... function cache($cacheName) { $arguments = func_get_args(); if (count($arguments) >= 2) { // two arguments passed. MUTATOR. $value = $arguments[1]; // use the second as the value $this->cache[$cacheName] = $value; // *change* the stored value } else { // 1 argument passed, ACCESSOR return $this->cache[$cacheName]; // *get* the stored value } } cache('foo', 'bar'); // nothing returned cache('foo') // 'bar' returned How do you document this in PHPDoc or a similar automated documentation creator? I had originally just written it like this: /** * Blah blah blah, you can use this as both a mutator and an accessor: * As an accessor: * @param $cacheName name of the variable to GET * @return string the value... * * As a mutator: * @param $cacheName name of the variable to SET * @param $value the value to set * @return void */ However, when this is run through phpDoc, it complains because there are 2 return tags, and the first @param $cacheName description is overwritten by the second. Is there a way around this?

  Read the article

• How much detail should be in a project plan or spec?

  - by DeanMc

  I have an issue that I feel many programmers can relate to... I have worked on many small scale projects. After my initial paper brain storm I tend to start coding. What I come up with is usually a rough working model of the actual application. I design in a disconnected fashion so I am talking about underlying code libraries, user interfaces are the last thing as the library usually dictates what is needed in the UI. As my projects get bigger I worry that so should my "spec" or design document. The above paragraph, from my investigations, is echoed all across the internet in one fashion or another. When a UI is concerned there is a bit more information but it is UI specific and does not relate to code libraries. What I am beginning to realise is that maybe code is code is code. It seems from my extensive research that there is no 1:1 mapping between a design document and the code. When I need to research a topic I dump information into OneNote and from there I prioritise features into versions and then into related chunks so that development runs in a fairly linear fashion, my tasks tend to look like so: Implement Binary File Reader Implement Binary File Writer Create Object to encapsulate Data for expression to the caller Now any programmer worth his salt is aware that between those three to do items could be a potential wall of code that could expand out to multiple files. I have tried to map the complete code process for each task but I simply don't think it can be done effectively. By the time one mangles pseudo code it is essentially code anyway so the time investment is negated. So my question is this: Am I right in assuming that the best documentation is the code itself. We are all in agreement that a high level overview is needed. How high should this be? Do you design to statement, class or concept level? What works for you?

  Read the article

• What constitutes a development environment, and how do you document it?

  - by Joel Coehoorn

  What items go into a software shop's development environment, how do you document it, and what processes do you follow to make changes? I thinking about this from the standpoint where I want to make it easier to bring new hires up to speed quickly by having all this on a checklist we follow when setting them up, and then while I'm at it making it easier for the new hires or existing team members to bring new powerful toolkits and ideas into the environment without disrupting things. I want to keep this platform agnostic, so even though I'm currently at a microsoft shop where Visual Studio would be assumed I'll go ahead and list compiler/IDE as one of the items: Here are some ideas for part 1: [edit]: I'm keeping this updated based on the better suggestions. Source Control access Issue/Bug/Project tracker System Documention, or references to find the system documentation in source control or in a wiki, including: build document/environment covered by this question design documents / technical notes Coding Style guidelines Deploy for review/testing/QA/staging/production procedures Licensing details for your tools and your product Team Calendar, including the project schedule(s), deadlines, vacation time, and support/on-call schedule (if required) compiler/IDE compiler/IDE extensions (things like source control plugins or visual studio add-ins) 3rd party SDKs/toolkits Database connection and tools Testing Frameworks Internal libraries communication tools (chat, wiki, etc) Static analysis tools (FxCop, FlawFinder, etc) Virtual machines (holding dev environment or for testing) Specialized editors (modeling, xml, etc) Other tools What else goes in this list, and how do you document it and vet changes?

  Read the article

• Is there a definitive reference document for Ruby syntax?

  - by JSW

  I'm searching for a definitive document on Ruby syntax. I know about the definitive documents for the core API and standard library, but what about the syntax itself? For instance, such a document should cover: reserved words, string literals syntax, naming rules for variables/classes/modules, all the conditional statements and their permutations, and so forth. I know there are many books and tutorials, yes, but every one of them is essentially a tutorial, each one having a range of different depth and focus. They will all, by necessity of brevity and narrative flow, omit certain details of the language that the author deems insignificant. For instance, did you know that you can use a case statement without an initial case value, and it will then execute the first true when clause? Any given Ruby book or tutorial may or may not cover that particular lesser-known functionality of the case syntax. It's not discussed in the section in "Programming Ruby" about case statements. But that is just one small example. So far the best documentation I've found is the rubyspec project, which appears to be an attempt to write a complete test suite for the language. That's not bad, but it's a bit hard to use from a practical standpoint as a developer working on my own projects. Am I just missing something or is there really no definitive readable document defining the whole of Ruby syntax?

  Read the article

• HTML5 Boilerplate : 4ème version de l'outil de prototypage de designs, documentation embarquée et de nouvelles @media queries

  HTML5 Boilerplate atteint sa quatrième version Code réorganisé, documentation embarquée, licence MIT et nouvelles @media queries La nouvelle version de HTML5 Boilerplate vient d'être distribuée. C'est le quatrième opus du fameux outil de prototypage de designs HTML5, à partir de templates HTML, CSS et JavaScript. Quoi de neuf dans cette version ? D'abord un nouveau site élégant, une nouvelle licence MIT (au lieu d'être simplement dans le domaine public), une documentation embarquée et un code réorganisé et épuré. Les commentaires « inlines » superflus ont été enlevés et les fichiers CSS, JS et les sous répertoires renommés. On remarque aussi une meilleure uniformisation du formatag...

  Read the article

• How to pin "Visual Studio 2010 Documentation" shortcut to Windows 7 taskbar?

  - by Chris W. Rea

  I just installed Microsoft Visual Studio 2010 at home, on my Windows 7 PC. One of the items installed with VS2010 is "Microsoft Visual Studio 2010 Documentation". I like to have the documentation installed locally and at my fingertips, and so before had always added a shortcut for the help viewer to my Quick Launch toolbar. However, I'm not able to pin the new documentation to the Windows 7 taskbar. It's frustrating. Note carefully: When I launch "Microsoft Visual Studio 2010 Documentation" from the Start menu, it seems to perform two functions: First, it launches the "Help Library Agent", which is a local HTTP server from which the help content is served... similar to the local ASP.NET web development server. Second, it launches the default web browser against the localhost URL corresponding to the port on which the "Help Library Agent" is running, for example: http://127.0.0.1:47873/help/1-1444/ms.help?method=f1&query=msdnstart&product=VS&productVersion=100&locale=en-US ... in other words, the program doesn't leave behind an active foreground process that displays in the taskbar. So, I can't choose "Pin this program to taskbar" as one might do so with a typical program. How can I get a shortcut to "Microsoft Visual Studio 2010 Documentation" in the Windows 7 taskbar? Has anybody got a workaround for this?

  Read the article

• Missing help files for Microsoft.WindowsMobile in Visual Studio 2008 help system

  - by Johann Gerell

  I've just installed the Windows Mobile 6.5.3 DTK, both standard and professional. Before that I had the standard and professional Windows Mobile 6 SDKs. All Windows Mobile help pages are missing in Visual Studio 2008's help system - in particular everything in the Microsoft.WindowsMobile namespace. Microsoft.WindowsMobile.DirectX is there, but it's not part of the Windows Mobile 6 SDK or 6.5.3 DTK. If I open the WM6 docs from the freshly created program group, then it's all fine and dandy, but there doesn't seem to have been a proper integration with VS during installation. Any ideas what's gone wrong and how to fix it?

  Read the article

• LaTeX Document eror: too many }'s

  - by Kyle

  Hello, I have a latex document, which works fine but when ever I try to add in an image with a figure caption it gives me an error saying there are to many }'s. \begin{figure}[h!] \caption{A picture of a gull.} \includegraphics[width=0.5\textwidth]{uml-usecase/overview.png} \end{figure} As far as I can see its right, can anyone figure out where I am going wrong? Thanks

  Read the article

• Java: JPQL date function to add a time period to another date

  - by bguiz

  SELECT x FROM SomeClass WHERE x.dateAtt BETWEEN CURRENT_DATE AND (CURRENT_DATE + 1 MONTH) In the above JPQL statement, SomeClass has a memebr dateAttr, which is a java.util.Date and has a @Temporal(javax.persistence.TemporalType.DATE) annotation. I need a way to do the (CURRENT_DATE + 1 MONTH) bit - it is obviously wrong in its current state - but cannot find the doc with the date function for JPQL. Can anyone point me in the direction of a doc that documents JPQL date functions (and also how to do this particular query)?

  Read the article

• How to browse .rst files ?

  - by Eric

  In many django projects, in the docs directory I can see *.rst files : What is the best way to browse them (without using a text editor of course) ? Is that possible to generate HTML ?

  Read the article

• Where to find good tech writers

  - by Stephane Grenier

  Where would you look to find great tech writers to write user manuals for software? Are there specific sites, areas of the web, etc. that are best to look for them?

  Read the article

• Doxygen ignoring inherited functions, when class inherits privately but the functions declared publi

  - by MichaelM

  Sorry for long winded title, this makes a lot more sense with an example. Suppose we have a class A: class A { public: void someFunction(); void someOtherFunction(); }; And another class that privately inherits from A. However, we re-declare one of the inherited functions as public: class B : private A { public: A::someFunction; } When this code is processed by Doxygen, it does not recognise the public declaration of someFunction in class B. Instead, it shows someFunction as a privately inherited function. This is incorrect. Is anybody aware of how to fix this? Cheers

  Read the article

• How to Pretty print VBA code?

  - by mraviator

  I need to "pretty print" VBA code into a Word document, retaining the color scheme from the VBE editor. I've been looking for free programs or methods to do this, but found nothing usable so far. Any ideas would be greatly appreciated. Thanks

  Read the article

• Document generation template engine for production usage NVelocity vs StringTemplate

  - by Chris Marisic

  For building a document generation engine what would be the primary .NET framework to be used in production. The 2 main ones I see are NVelocity and StringTemplate. NVelocity in all forks to be almost unsupported at this point where as ST been active atleast as of this year. Are either or both of these stable for use in production (if nv which fork)? Has anyone had any particularly good success with or failures using either of those frameworks?

  Read the article

• TERASOLUNA English Manual

  - by cedric

  Hi. I was looking for an english version of terasoluna framework manual or tutorial but can't find any. Can anyone help me with this. Because currently it is in japanese

  Read the article

• GNU Smalltalk API?

  - by Zachary

  I have recently been learning Smalltalk, mainly by going through the tutorial at gnu.org. While it has been really helpful and I have learned a lot, I would really like an extensive smalltalk API where I could view all of the built in objects and which messages they can receive, and what they will do with those messages. The manual has a list of all of the built in objects, but doesn't really explain anything about them. Some are obvious, like an Array, but I still don't know what all the messages are an Array understands. There is a link to a 'class reference' here, which is generated by Smalltalk, but the link is broken. I was wondering if anyone knows of something like this hosted elsewhere, or could point me towards a similar resource.

  Read the article

< Previous Page | 23 24 25 26 27 28 29 30 31 32 33 34  | Next Page >