1

Topic: Help and documentation creation

What you see the program creating help to something or the documentation? Than you create help for the programs (not including pure HTML) and what program you would like? What should she be able?

2

Re: Help and documentation creation

Hello, Submitter, you wrote: S> What you see the program creating help to something or the documentation? S> than you create help for the programs (not including pure HTML) and what program you would like? What should she be able? While most  help turns out in chm.

3

Re: Help and documentation creation

Hello, kov_serg, you wrote: S>> What you see the program creating help to something or the documentation? S>> than you create help for the programs (not including pure HTML) and what program you would like? What should she be able? _> while most  help turns out in chm. Same it is very strongly obsolete. I remember years 10-12 was Microsoft Work Shop (or somehow so), but same it is very obsolete?

4

Re: Help and documentation creation

Hello, Submitter, you wrote: S> What you see the program creating help to something or the documentation? S> than you create help for the programs (not including pure HTML) and what program you would like? What should she be able? Here at a forum sometimes there is a developer of one such program.

5

Re: Help and documentation creation

Hello, Submitter, you wrote: _>> While most  help turns out in chm. S> Same it is very strongly obsolete. [skip] and what is not became outdated? PDF, whether that?

6

Re: Help and documentation creation

Hello, Lazytech, you wrote: L> Here at a forum sometimes there is a developer of one such program. DrExplain? All hands do not reach to download and look.

7

Re: Help and documentation creation

Hello, Submitter, you wrote: S> What you see the program creating help to something or the documentation? A simple initial format + templates + scripts (for parametrization, transfers and a finishing of texts) + utilities for conversions of texts (from javadoc, doxugen and .) and then  chm, epub/fb2, pdf (a4, a5...), man, tex. And if also the made editor that normal teachers could do electronic textbooks, would be remarkable. S> than you create help for the programs (not including pure HTML) and what program you would like? What should she be able? Should be , not exacting, without dependences and to work from xp to linux

8

Re: Help and documentation creation

Hello, kov_serg, you wrote: _> a simple initial format + templates + scripts (for parametrization, transfers and a finishing of texts) + utilities for conversions of texts (from javadoc, doxugen and .) _> and then  chm, epub/fb2, pdf (a4, a5...), man, tex. I have Nothing against such formats as epub/fb2 and pdf, but frequently it is difficult to find something in such documents. That is search function is, but here is how it works... Especially it concerns documents PDF containing hundreds of pages. P.S. The correction: partially I remove the claim to format FB2 as there search goes quickly enough. But all the same to search not so conveniently, as there enough for stupid search, approximately as in the Notepad. P.P.S. By the way, search in document PDF sometimes does not find even those word combinations which in it precisely are, because of hard hyphen the next line.

9

Re: Help and documentation creation

Hello, Submitter, you wrote: S> DrExplain? All hands do not reach to download and look. The typical error - to begin development without studying competitors.

10

Re: Help and documentation creation

Hello, Submitter, you wrote: S> Than you create help for the programs (not including pure HTML) and what program you would like? What should she be able? I began to use https://dotnet.github.io/docfx/, corrected templates a little and added scripts that it was generated chm. As a result the automatic machine I receive html files for a site, chm a file for the program and in addition pdf for fans. And all is free. So, probably, it is possible to be torn in this niche. For example, there is a task: the program interface changes, therefore it is necessary to alter such and such screenshots. Here it to automate. Perhaps certainly, also there is already a decision.

11

Re: Help and documentation creation

Hello, Unhandled_Exception, you wrote: U_E> So, probably, it is possible to be torn in this niche. For example, there is a task: the program interface changes, therefore it is necessary to alter such and such screenshots. Here it to automate. Perhaps certainly, also there is already a decision. About creation of screenshots violently . I wrote a bicycle, and I use it. But there is no functional, for example, between the first and second screenshot it is necessary to produce any actions in application from which we remove screenshots, and now I softina-skrinshotosnimalka is able to deduce only an inscription "fulfill action , and push on Further" that is inconvenient. The program is necessary, which itself can click the necessary elements, withstand pauses if it is necessary, and to remove screenshots. And, of course, the convenient editor of these scenarios - that there was both the language and separate GUI for its editing without  in a notepad. The program is necessary as separate programs-skrinshotosnimalka, in  from the program-dokumentirovalki. If there will be a good decision, is ready to buy the license for $99.

12

Re: Help and documentation creation

S> What you see the program creating help to something or the documentation? Help is not necessary. The browser is.

13

Re: Help and documentation creation

Hello, rean, you wrote: R> Help is not necessary. The browser is. And what for then use PDF, CHM and other formats? "The browser is".

14

Re: Help and documentation creation

Hello, Submitter, you wrote: S> Than you create help for the programs (not including pure HTML) and what program you would like? What should she be able? We passed on Dr. Explain https://www.drexplain.ru/It arranges with all. In it there is an automatic generation of screenshots and  description GUI. That we deliver clients: CHM - in the distribution kit if at the client is not present  (for example on business trip). PDF - we send on demand of clients (such regularly happen). HTML - on a site - it is mandatory and very convenient for . to give references to specific answers and chapters. Here which we use the complete set.

15

Re: Help and documentation creation

Hello, Matrix_Failure, you wrote: M_F> We passed on Dr. Explain M_F> https://www.drexplain.ru/M_F> It arranges with all. Competitors looked? What was still remembered?

16

Re: Help and documentation creation

Hello, Submitter, you wrote: M_F>> We passed on Dr. Explain S> Competitors looked? What was still remembered? Even applied, but there was not automatic  screenshots. With its help very conveniently and quickly (!) to update a help at release of new versions. You push "to Seize the Screen", tyshch-pyshch and it is ready. Only to add  the description of new buttons.

17

Re: Help and documentation creation

Hello, Matrix_Failure, you wrote: S>> Competitors looked? What was still remembered? M_F> even applied, but there was not automatic  screenshots. With its help very conveniently and quickly (!) to update a help at release of new versions. Tyshch-pyshch also it is ready. Only to add  the description of new buttons. Can explain briefly that such "automatic generation of screenshots" and how it works?

18

Re: Help and documentation creation

Hello, Submitter, you wrote: S> Can explain briefly that such "automatic generation of screenshots" and how it works? You push "to Add section with the annotated screen" and Dr. Explain scans in our program interface elements,  them, and creates in a help the annotated screen of the program. To update screen copies in the new version you push the right mouse button and you select "to Replace with capture".

19

Re: Help and documentation creation

Hello, Submitter, you wrote: S> Than you create help for the programs (not including pure HTML) and what program you would like? What should she be able? As the person who is a little in a subject, I will state some theses about a niche as a whole: 1) Needs and nuances at all projects very different.  it is heavy to one to make happy all. With  there is one serious mental trap of the developer - "what there to write? Took a ready component of the editor, fastened a tree of sections, export to some formats... PROFIT". To me often say that we  is cloned for half a year. And a devil in details, on some of which cheloveko-months leave. And in professional tools which the person can use all the working day long, details and trifles are very important. Struggle is conducted for everyone superfluous cliques, for everyone, it is possible to tell, pixel. 2) Sharovarshchiki - at all that segment on which it is necessary aims. Here some from last domestic : * Asfaltobetonnyj factory * the Stevedore company * mortgage lending Agency * Service on sale of aviation and railway tickets * the Trading house * the Builder * Publishing house * Design agency * the Geodesic company * Bank * the Network of supermarkets * Agency of a cargo transportation * the Company on repair and a construction of roads * Developers of the medical equipment * Ship-building factory * Geological scientific research institute Therefore with the active advertizing very difficult. There is no accurate segment in which it would be possible aims with guaranteed ROI. Mass bombardments do not transit, only sniper tactics. 2) Nish it is very sated - the ocean is red from blood. A cycle of sales very long. It is necessary to compete not only to a heap of commercial decisions in all price segments and them  versions, but also with a heap free - , Google ,  etc. And thus that is very important, it is necessary to compete also and with  a sight "the help especially is not necessary to anybody. Let's hastily something in a Word on ten pages ". I.e. at first it is necessary to convince simply the client that to it  a help, and then still to convince that it is necessary to write this help to yours . Now, I am not assured that would get here, knowing as here all. Since 2005 the landscape strongly exchanged.

20

Re: Help and documentation creation

R>> Help is not necessary. The browser is. S> And what for then use PDF, CHM and other formats?" The browser is ". PDF for the press. That the secretary learned something by heart. And that  a paper to the director, showing that it is necessary to buy. And that  everyones and other was in . And CHM what for? Then that it MS made for Win95 instead of HLP from Win3.11. That the user pushed F1 if he does not understand anything. Now the help build in directly the program interface. This right decision as solves a problem of a duality and coordination loss. , directly in the interface, the image, the circuit, animations and even video it is possible to build in text notices directly the program. If it would be desirable to learn to use the program, it is necessary to do not helps on which anything never to find, not PDF on 400 pages, and training videos and articles on a site. That the user was threw off in a seat, looked, listened or read, from time to time pushing Next. And then villages for the program and understanding it, did that is necessary for it, instead of was stuck under not clear menus and buttons, guessing that it. If it would be desirable pdf make a crib in one page which can be hung up on a wall over the monitor. An excellent example of such crib - short dock on programming OpenCL.

21

Re: Help and documentation creation

Hello, Dennis Crane, you wrote: I Thank for the torn answer. Still a question: I see that on a site of the company at you only 2 programs. Really only on them two "are fed"? Still the question is a little on other subject: was going to leave from GoDaddy, and you do not think to make the same? Speak GoDaddy locks domains on different to the reasons, but be afraid, what it happens to you? I am going to leave and I solve to whom from these three: NameCheap, Domain, Name (sites with the same name).

22

Re: Help and documentation creation

Hello, Submitter, you wrote: S> Hello, Dennis Crane, you wrote: S> I Thank for the torn answer. Still a question: I see that on a site of the company at you only 2 programs. Really only on them two "are fed"? We are fed from one, actually, but it is permanently tried new directions since to be full from one project all becomes more difficult and more expensive. S> still the question is a little on other subject: was going to leave from GoDaddy, and you do not think to make the same? Speak GoDaddy locks domains on different to the reasons, but be afraid, what it happens to you? I am going to leave and I solve to whom from these three: NameCheap, Domain, Name (sites with the same name). There is no definite answer. Where the warranty, what NameCheap does not make the same if somebody pushes it? In the present world you do not know, the black swan whence arrives. Walk-field in Internet business of the sample of the beginning 2000 ended. Regulators clamp from different directions, attention to IT and to e-business all more steadfastly since it became real sector of economy and the sociopolitical tool. Someone large (the states, corporations, special services) permanently wants to advance the interests, and a trifle  because of it.

23

Re: Help and documentation creation

Hello, Submitter, you wrote: S> Hello, kov_serg, you wrote: S>>> What you see the program creating help to something or the documentation? S>>> than you create help for the programs (not including pure HTML) and what program you would like? What should she be able? _>> while most  help turns out in chm. S> Same it is very strongly obsolete. I remember years 10-12 was Microsoft Work Shop (or somehow so), but same it is very obsolete? Microsoft Work Shop goes wood. This poverty to use not probably. While the compiler hhc after a small patch works like clock-work.

24

Re: Help and documentation creation

Hello, Lazytech, you wrote: L> Hello, kov_serg, you wrote: L> I have Nothing against such formats as epub/fb2 and pdf, but frequently it is difficult to find something in such documents. That is search function is, but here is how it works... Especially it concerns documents PDF containing hundreds of pages. pdf as a format for the press, instead of for search. epub for  . Is still dvi and ps but it is not assured that they so are widely used. The search problem dares a normal table of contents and the index. Search there not so is important. Idea in that that the document could be published as on a desktop so on electronic books, phones, and as to unpack as the book,  or the instruction or it is even better to prepare for issuing in printing house. L> P.S. The correction: partially I remove the claim to format FB2 as there search goes quickly enough. But all the same to search not so conveniently, as there enough for stupid search, approximately as in the Notepad. So for a desktop the most kosher format chm (but it only with one code  works though it not is serious restriction for html which is able to encode characters out of the code page). L> P.P.S. By the way, search in document PDF sometimes does not find even those word combinations which in it precisely are, because of hard hyphen the next line. Whether it already  to  to it   pores of difficultly ligature (type fl fi...) to letters to transform. Though happen and   the scanned pages in pdf and  fonts. Though even normal xpdf can easy take out the made text for an indexing while  takes out relic radiation.

25

Re: Help and documentation creation

S> What you see the program creating help to something or the documentation? S> than you create help for the programs (not including pure HTML) and what program you would like? What should she be able? As Denis correctly hinted you, eliminate second half of question and leave only the first: "as you see the program for documentation creation?" I will explain: now there was a huge layer of applications generally without the documentation: web applications and . Helps there in 99 % stupidly are not present generally. There are helps, the rollers which have been built in  . The new generation trained on such programs, will expect something similar and from a normal software. Therefore the correct help for a software it  + faq,  frequently is not required. And here documentation compilation, is a subject more interesting. But also there frequently it not end in itself, and a compulsory measure. That is the IKEA can make desktop, but without the instruction on the assembly it will be heavy to it to sell it. Or if it is the state order any documentation should be is mandatory enclosed. It probably also will not read, but it should be. That is to you very much buyers not behind the decision of a primary problem of business, and behind disposal of inevitable harm easily go. And it means that to the potential buyer can be basically  what exactly to buy, if only worked. Here, probably, to Denis is what to tell more and better me, but I think is near from true: in this niche a little that depends on the program. And further the most interesting: most likely there are any standards of design of the documentation in this or that area, and they easily can be of great value, rather than advanced text editor about which you now think. And money very much can be, are in this area of correspondence to standards. And without understanding as it there is actually, to earn it does not turn out. , I there would not climb, especially if in a head help to a software. It  lockup. At last history: the core was one company which was engaged CAD th and the adjacent 3D-themes. It also let out a software which allowed to "disassemble/collect" 3d-modelku, to photograph process in the form of a series of frames, to draw it in style of schematic drawings and to add to each step of the description. Such generator of instructions on the assembly/dismantling of any mechanisms turned out. This company to the large avia-vendor also came, the pier here at us that is. Those looked, estimated, but refused to buy. The reason was that: at them similar instructions were made by department of the order of thousand persons. If they bought this program, they almost should be dismissed all that would create it an array of problems of other sort. , the documentation is a difficult subject